Get all mass assignment processes for development goals
get
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess
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 mass assignment processes for development goals that match the primary key criteria specified.
Finder Variables- MassRequestId; integer; Unique identifier for the mass assignment request for development goals.
- filterTalentPoolGoals Finds all mass assignment processes for development goals based on the specified process name or requester; string; 's name.
Finder Variables- MassRequestId; integer; Unique identifier for the mass assignment request for development goals.
- findByAdvancedSearch Finds all mass assignment processes for development goals based on the specified process name or requester; string; 's name.
Finder Variables- processName; string; Name of the mass assignment process for development goals.
- requester; string; Name of the person requesting the mass assignment process for development goals.
- PrimaryKey Finds all mass assignment processes for development goals that match the primary key criteria specified.
-
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:- Assignee; integer; A code that determines the employees in the hierarchy of the requester who need to be assigned the development goals included in the mass assignment process.
- CreatedBy; string; Name of the person who created the mass assignment process for development goals.
- CreationDate; string; Date the mass assignment process for development goals was created.
- LastUpdateDate; string; Date the mass assignment process for development goals was last updated.
- LastUpdatedBy; string; Name of the person who last updated the mass assignment process for development goals.
- MassProcessName; string; Name of the mass assignment process for development goals.
- MassRequestId; integer; Unique identifier for the mass assignment request for development goals.
- RequestOnBehalfOfPersonId; integer; Unique identifier for the person requesting the mass assignment process for development goals.
- RequestSubmittedByPersonId; integer; Unique identifier for the person submitting the mass assignment process for development goals.
- RequestTypeCode; string; Request type of the mass assignment process for development goals.
- RequesterName; string; Display name of the person requesting the mass assignment process for development goals.
-
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 TopResponse
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 : devGoalsMassAssignProcess
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : devGoalsMassAssignProcess-item-response
Type:
Show Source
object
-
Assignee: integer
(int64)
Title:
Assignees
A code that determines the employees in the hierarchy of the requester who need to be assigned the development goals included in the mass assignment process. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the person who created the mass assignment process for development goals. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date the mass assignment process for development goals was created. -
devEligibilityProfiles: array
Development Eligibility Profiles
Title:
Development Eligibility Profiles
The devEligibilityProfiles resource is a child of the devGoalsMassAssignProcesses resource and provides all eligibility profiles that are added to the mass assignment process of development goals. -
devExcludedWorkers: array
Development Excluded Workers
Title:
Development Excluded Workers
The devExcludedWorkers resource is a child of the devGoalsMassAssignProcesses resource and provides all the workers who are excluded from the mass assignment process of development goals. -
devGoals: array
Development Goals
Title:
Development Goals
The developmentGoals resource provides the development goals of a worker. -
devIncludedWorkers: array
Development Included Workers
Title:
Development Included Workers
The devIncludedWorkers resource is a child of the devGoalsMassAssignProcesses resource and provides workers who need to be assigned the development goals that are part of the mass assignment process. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date the mass assignment process for development goals was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the person who last updated the mass assignment process for development goals. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassProcessName: string
Title:
Process Name
Maximum Length:200
Name of the mass assignment process for development goals. -
MassRequestId: integer
(int64)
Unique identifier for the mass assignment request for development goals.
-
RequesterName: string
Title:
Requester
Read Only:true
Maximum Length:240
Display name of the person requesting the mass assignment process for development goals. -
RequestOnBehalfOfPersonAssignmentId: integer
(int64)
Title:
Manager Assignment
Unique identifier for the assignment of the person requesting the mass assignment process for development goals. -
RequestOnBehalfOfPersonId: integer
(int64)
Title:
Requester
Unique identifier for the person requesting the mass assignment process for development goals. -
RequestSubmittedByPersonId: integer
(int64)
Title:
Requested By
Unique identifier for the person submitting the mass assignment process for development goals. -
RequestTypeCode: string
Title:
Request Type
Maximum Length:30
Default Value:ORA_HRG_GL_MASS_ASGN_TEMPLATE
Request type of the mass assignment process for development goals.
Nested Schema : Development Eligibility Profiles
Type:
array
Title:
Development Eligibility Profiles
The devEligibilityProfiles resource is a child of the devGoalsMassAssignProcesses resource and provides all eligibility profiles that are added to the mass assignment process of development goals.
Show Source
Nested Schema : Development Excluded Workers
Type:
array
Title:
Development Excluded Workers
The devExcludedWorkers resource is a child of the devGoalsMassAssignProcesses resource and provides all the workers who are excluded from the mass assignment process of development goals.
Show Source
Nested Schema : Development Goals
Type:
array
Title:
Development Goals
The developmentGoals resource provides the development goals of a worker.
Show Source
Nested Schema : Development Included Workers
Type:
array
Title:
Development Included Workers
The devIncludedWorkers resource is a child of the devGoalsMassAssignProcesses resource and provides workers who need to be assigned the development goals that are part of the mass assignment process.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : devGoalsMassAssignProcess-devEligibilityProfiles-item-response
Type:
Show Source
object
-
EligibilityProfileDescription: string
Read Only:
true
Maximum Length:255
Description of the eligibility profile associated with the mass assignment process of development goals. -
EligibilityProfileId: integer
(int64)
Title:
Eligibility Profile
Unique identifier for the eligibility profile. -
EligibilityProfileName: string
Read Only:
true
Maximum Length:255
Name of the eligibility profile associated with the mass assignment process of development goals. -
EligibilityProfileObjectId: integer
(int64)
Unique internal identifier for the eligibility profile within the mass assignment process of development goals.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RequiredFlag: boolean
Title:
Required
Maximum Length:1
Indicates if the eligibility profile is required. -
TalentObjectType: string
Maximum Length:
30
Indicates the type of Talent object associated with the eligibility profile, which is the mass assignment process of development goals.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : devGoalsMassAssignProcess-devExcludedWorkers-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Unique identifier for the assignment of the worker excluded from the mass assignment process of development goals.
-
AssignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Name of the assignment of the worker excluded from the mass assignment process of development goals. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the worker excluded from the mass assignment process of development goals. -
AssignmentStatusType: string
Title:
Assignment Status
Read Only:true
Maximum Length:30
Status type for the assignment of the worker to be excluded from the mass assignment process of development goals. -
BusinessTitle: string
Title:
Job
Read Only:true
Maximum Length:255
Business title of the worker excluded from the mass assignment process of development goals. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the person who excluded the worker from the mass assignment process of development goals. -
CreationDate: string
(date-time)
Read Only:
true
Date when the worker was excluded from the mass assignment process. -
DepartmentName: string
Title:
Department
Read Only:true
Maximum Length:255
Name of the department of the worker excluded from the mass assignment process of development goals. -
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the worker excluded from the mass assignment process. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the details of the worker excluded from the mass assignment process of development goals was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the person who last updated the details of the worker excluded from the mass assignment process of development goals. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerName: string
Title:
Manager Name
Read Only:true
Maximum Length:255
Name of the manager of the worker excluded from the mass assignment process of development goals. -
MassRequestExemptionId: integer
(int64)
Unique identifier for the mass request exemption.
-
MassRequestHierarchyId: integer
(int64)
Read Only:
true
Default Value:-1
Unique identifier for the mass request hierarchy. -
PersonId: integer
(int64)
Title:
Person
Unique identifier for the worker excluded from the mass assignment process. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the worker excluded from the mass assignment process. -
PositionName: string
Title:
Position
Read Only:true
Maximum Length:255
Name of the position of the worker excluded from the mass assignment process of development goals.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : devGoalsMassAssignProcess-devGoals-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Status
Maximum Length:30
Indicates if the development goal is active or not. -
ActualCompletionDate: string
(date)
Title:
Actual Completion Date
Actual completion date of development goal. -
AllowKeyAttrUpdateFlag: boolean
Title:
Allow Workers to Update Key Attributes
Maximum Length:30
Default Value:true
Indicates if managers or workers can update the key attributes of a development goal. -
CategoryCode: string
Title:
Category
Maximum Length:30
Category code of a development goal. -
CategoryMeaning: string
Title:
Category
Read Only:true
Maximum Length:80
Category for the development goal. -
Comments: string
(byte)
Title:
Goal-specific Comments
Comments for the development goal. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the development goal. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date the development goal was created. -
Description: string
Title:
Description
Maximum Length:4000
Description for the development goal. -
GoalApprovalState: string
Maximum Length:
30
Approval state of the development goal. -
GoalId: integer
(int64)
Title:
Goal ID
Unique identifier for the development goal. -
GoalName: string
Title:
Goal Name
Maximum Length:400
Name of the development goal. -
GoalSourceCode: string
Title:
Source
Maximum Length:30
Source code that indicates who created the development goal. A development goal can be created by a worker, a manager, or an HR specialist. -
GoalVersionTypeCode: string
Title:
Goal Version Type
Maximum Length:30
Default Value:ACTIVE
Version code of the development goal. -
LastModifiedDate: string
(date-time)
Title:
Last Updated
Date the development goal was last modified. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date the development goal was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the development goal. -
LevelCode: string
Title:
Level
Maximum Length:30
Code that indicates the development goal level. -
LevelMeaning: string
Title:
Level
Read Only:true
Maximum Length:80
Level of the development goal. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassRequestId: integer
(int64)
Unique identifier for the mass assignment request for development goals.
-
PercentComplete: string
Title:
Completion Percentage
Maximum Length:30
Goal completion percentage code. -
PersonId: integer
(int64)
Title:
Person ID
Unique identifier for the person who's assigned the development goal. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the person who's assigned the development goal. -
PriorityCode: string
Title:
Priority
Maximum Length:30
Default Value:MEDIUM
Priority code of the development goal. -
PriorityMeaning: string
Title:
Priority
Read Only:true
Maximum Length:80
Priority of the development goal. -
PrivateFlag: boolean
Title:
Private
Maximum Length:30
Default Value:false
Indicates if the development goal is private or not. -
RequestContext: string
Maximum Length:
30
Indicates the flow from which the development goal was created. The goal could have been added from a Talent Review meeting or by mass assignment. -
RequiresApprovalStatus: string
Indicates if the development goal needs to be approved.
-
StartDate: string
(date)
Title:
Start Date
Start date of the development goal. -
Status: string
Title:
Status
Maximum Length:30
Default Value:NOT_STARTED
Status code of the development goal. -
StatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of status code of development goal. -
SuccessCriteria: string
(byte)
Title:
Success Criteria
Success criteria of the development goal. -
TargetCompletionDate: string
(date)
Title:
Target Completion Date
Target completion date for the development goal.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : devGoalsMassAssignProcess-devIncludedWorkers-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Title:
Manager Assignment
Unique identifier for the assignment of the worker included in the mass assignment process of development goals. -
AssignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Name of the assignment of the worker included in the mass assignment process of development goals. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the worker included in the mass assignment process of development goals. -
AssignmentStatusType: string
Title:
Assignment Status
Read Only:true
Maximum Length:30
Assignment status type of the worker included in the mass assignment process of development goals. -
BusinessTitle: string
Title:
Job
Read Only:true
Maximum Length:255
Business title of the worker included in the mass assignment process of development goals. -
CascadingLevel: integer
(int64)
Title:
Assignees
A code that determines which employees reporting to the requester will be assigned the development goals during the mass assignment process. The development goals can be assigned only to the requester, all direct reports of the requester, all direct reports of the requester and the requester, all reports of the requester, and all reports of the requesters and the requester. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who added the worker to the mass assignment process of development goals. -
CreationDate: string
(date-time)
Read Only:
true
Date the worker was included in the mass assignment process of development goals. -
DepartmentName: string
Title:
Department
Read Only:true
Maximum Length:255
Name of the department that the worker included in the mass assignment process of development goals belongs to. -
DirectsCount: integer
Read Only:
true
Count of persons who report directly to the manager included in the mass assignment process of development goals. -
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the worker included in the mass assignment process of development goals. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the details of the worker included in the mass assignment process of development goals was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the details of the worker included in the mass assignment process of development goals. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerName: string
Title:
Manager Name
Read Only:true
Maximum Length:255
Name of the manager of the worker included in the mass assignment process of development goals. -
MassRequestHierarchyId: integer
(int64)
Title:
Mass Request Hierarchy ID
Unique identifier for the mass request hierarchy. -
PersonId: integer
(int64)
Title:
Person
Unique identifier of the worker included in the mass assignment process of development goals. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the worker included in the mass assignment process of development goals. -
PositionName: string
Title:
Position
Read Only:true
Maximum Length:255
Name of the position of the worker included in the mass assignment process of development goals.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- findByAdvancedSearchQuery
-
Operation: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/action/findByAdvancedSearchQueryFinds mass assignment processes for development goals that match the specified parameters.