Get all representatives
get
/hcmRestApi/resources/11.13.18.05/areasOfResponsibility
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 the areas of responsibility values that match the primary key criteria specified.
Finder Variables- ResponsibilityId; integer; Responsibility's unique identifier.
- PrimaryKey Finds all the areas of responsibility values 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:- ActiveStatus; string; Status of the responsibility, such as active or inactive.
- AssignmentCategory; string; Value of the responsibility's assignment category code.
- AssignmentId; integer; Surrogate identifier for the representative's assignment.
- AssignmentName; string; Name of the representative's assignment.
- AssignmentNumber; string; Unique assignment identifier of the representative who has one or more responsibilities.
- BargainingUnitCode; string; Value of the responsibility's bargaining unit code.
- BenefitGroupId; integer; Value of the responsibility's benefit group identifier.
- BenefitGroupName; string; Name of the responsibility's benefit group.
- BusinessUnitId; integer; Value of the responsibility's business unit identifier.
- BusinessUnitName; string; Name of the responsibility's business unit.
- CountryCode; string; Country code of the responsibility.
- CreatedBy; string; User who created the responsibility.
- CreationDate; string; Date and time when the responsibility was created.
- DepartmentId; integer; Department identifier of the responsibility.
- DepartmentName; string; Name of the responsibility's department.
- DepartmentTreeCode; string; Value of the responsibility's department tree code.
- DepartmentTreeName; string; Department tree name of the responsibility.
- DisplayName; string; Display name of the representative with the responsibility.
- EndDate; string; The responsibility's end date.
- GradeCode; string; Grade code of the responsibility.
- GradeId; integer; Grade identifier of the responsibility.
- GradeName; string; Name of the responsibility's grade.
- GradeSetCode; string; Grade set code of the responsibility.
- HierarchyType; string; Hierarchy type of the responsibility, such as AOR_DEPT.
- HierarchyTypeMeaning; string; Description of the responsibility's hierarchy type.
- JobCode; string; Job code of the responsibility.
- JobFamilyCode; string; Job family code of the responsibility.
- JobFamilyId; integer; Job family identifier of the responsibility.
- JobFamilyName; string; Job family name of the responsibility.
- JobFunctionCode; string; Job function code of the responsibility.
- JobFunctionMeaning; string; Description of the responsibility's job function.
- JobId; integer; Job identifier of the responsibility.
- JobName; string; Job name of the responsibility.
- JobSetCode; string; Job set code of the responsibility.
- LastUpdateDate; string; Date and time when the responsibility was last updated.
- LastUpdatedBy; string; User who last updated the responsibility.
- LegalEmployerName; string; Legal employer name of the responsibility.
- LegalEntityId; integer; Legal entity identifier of the responsibility.
- LegislativeDataGroupId; integer; Legislative data group identifier of the responsibility.
- LegislativeDataGroupName; string; Legislative data group name of the responsibility.
- LocationCode; string; Location code of the responsibility.
- LocationId; integer; Location identifier of the responsibility.
- LocationName; string; Location name of the responsibility.
- LocationSetCode; string; Location set code of the responsibility.
- OrganizationTreeCode; string; Organization tree code of the responsibility.
- OrganizationTreeName; string; Organization tree name of the responsibility.
- PayrollId; integer; Payroll identifier of the responsibility.
- PayrollName; string; Payroll name of the responsibility.
- PayrollStatUnitId; integer; Payroll statutory unit identifier of the responsibility.
- PayrollStatutoryUnitName; string; Payroll statutory unit name of the responsibility.
- PersonId; integer; Person identifier of the representative.
- PersonNumber; string; Person number of the representative.
- PositionCode; string; Position code of the responsibility.
- PositionId; integer; Position identifier of the responsibility.
- PositionName; string; Position name of the responsibility.
- PositionTreeCode; string; Position tree code of the responsibility.
- PositionTreeName; string; Position tree name of the responsibility.
- RecruitingLocHierarchyId; integer; Recruiting location hierarchy identifier of the responsibility.
- RecruitingLocHierarchyName; string; Recruiting location hierarchy name of the responsibility.
- RecruitingOrgHierarchyId; integer; Recruiting organization hierarchy identifier of the responsibility.
- RecruitingOrgHierarchyName; string; Recruiting organization hierarchy name of the responsibility.
- RecruitingTypeCode; string; Recruiting type code of the responsibility.
- RecruitingTypeMeaning; string; Description of the responsibility's recruiting type.
- ResponsibilityId; integer; Identifier of the responsibility.
- ResponsibilityName; string; Name of the responsibility.
- ResponsibilityType; string; Type of the responsibility.
- ResponsibilityTypeMeaning; string; Description of the responsibility's representative type.
- StartDate; string; Start date of the responsibility.
- TemplateCode; string; Description of the responsibility template code that's associated to this responsibility.
- TemplateId; integer; Responsibility template identifier associated to this responsibility.
- TemplateName; string; Responsibility template name associated to this responsibility.
- TopDepartmentId; integer; Top department identifier of the responsibility.
- TopDepartmentName; string; Top department name of the responsibility.
- TopManagerId; integer; Top manager identifier of the responsibility.
- TopManagerName; string; Top manager name of the responsibility.
- TopManagerNumber; string; Surrogate identifier for the top manager.
- TopOrganizationId; integer; Top organization identifier of the responsibility.
- TopOrganizationName; string; Top organization name of the responsibility.
- TopPositionId; integer; Top position identifier of the responsibility.
- TopPositionName; string; Top position name of the responsibility.
- Usage; string; Value of the responsibility's usage. It can contain multiple comma-separated values, such as ORA_PER_AOR_APPROVAL and ORA_PER_AOR_CHECKLIST.
- WorkContactsFlag; boolean; Work contact of the responsibility, such as include or exclude.
-
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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 : areasOfResponsibility
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 : areasOfResponsibility-item-response
Type:
Show Source
object
-
ActiveStatus: string
Title:
Status
Maximum Length:30
Status of the responsibility, such as active or inactive. -
AssignmentCategory: string
Title:
Assignment Category Code
Maximum Length:30
Value of the responsibility's assignment category code. -
AssignmentCategoryMeaning: string
Title:
Assignment Category
Read Only:true
Maximum Length:80
Description of the responsibility's assignment category. -
AssignmentId: integer
(int64)
Title:
Assignment ID
Surrogate identifier for the representative's assignment. -
AssignmentName: string
Title:
Business Title
Read Only:true
Maximum Length:80
Name of the representative's assignment. -
AssignmentNumber: string
Title:
Assignment Number
Maximum Length:30
Unique assignment identifier of the representative who has one or more responsibilities. -
BargainingUnit: string
Title:
Bargaining Unit
Read Only:true
Maximum Length:80
Description of the responsibility's bargaining unit. -
BargainingUnitCode: string
Title:
Bargaining Unit Code
Maximum Length:30
Value of the responsibility's bargaining unit code. -
BenefitGroupId: integer
(int64)
Title:
Benefit Group ID
Value of the responsibility's benefit group identifier. -
BenefitGroupName: string
Title:
Benefit Group
Maximum Length:240
Name of the responsibility's benefit group. -
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Value of the responsibility's business unit identifier. -
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the responsibility's business unit. -
Country: string
Title:
Country
Read Only:true
Maximum Length:80
Country of the responsibility. -
CountryCode: string
Title:
Country Code
Maximum Length:30
Country code of the responsibility. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the responsibility. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the responsibility was created. -
DepartmentId: integer
(int64)
Title:
Department ID
Department identifier of the responsibility. -
DepartmentName: string
Title:
Department
Maximum Length:240
Name of the responsibility's department. -
DepartmentTreeCode: string
Title:
Department Tree Code
Maximum Length:30
Value of the responsibility's department tree code. -
DepartmentTreeName: string
Title:
Department Hierarchy
Read Only:true
Maximum Length:80
Department tree name of the responsibility. -
DepartmentTreeVersionId: string
Title:
Department Tree Version ID
Maximum Length:32
Department tree version identifier of the responsibility. -
DepartmentTreeVersionName: string
Title:
Department Tree Version Name
Read Only:true
Maximum Length:80
Department tree version name of the responsibility. -
DisplayName: string
Title:
Person Name
Read Only:true
Maximum Length:240
Display name of the representative with the responsibility. -
EndDate: string
(date)
Title:
To Date
The responsibility's end date. -
GradeCode: string
Title:
Grade Code
Maximum Length:30
Grade code of the responsibility. -
GradeId: integer
(int64)
Title:
Grade ID
Grade identifier of the responsibility. -
GradeName: string
Title:
Grade
Read Only:true
Maximum Length:240
Name of the responsibility's grade. -
GradeSetCode: string
Title:
Grade Set Code
Maximum Length:30
Grade set code of the responsibility. -
HierarchyLevels: integer
(int32)
Title:
Hierarchy Levels
Hierarchy level of the responsibility. -
HierarchyType: string
Title:
Hierarchy Type Code
Maximum Length:30
Hierarchy type of the responsibility, such as AOR_DEPT. -
HierarchyTypeMeaning: string
Title:
Hierarchy Type
Read Only:true
Maximum Length:80
Description of the responsibility's hierarchy type. -
IncludeTopHierNodeFlag: boolean
Title:
Include Top Hierarchy Node
Maximum Length:30
Value of the responsibility's Include Top Hierarchy Node. Valid values are Y or N. -
JobCode: string
Title:
Job Code
Maximum Length:30
Job code of the responsibility. -
JobFamilyCode: string
Title:
Job Family Code
Maximum Length:240
Job family code of the responsibility. -
JobFamilyId: integer
(int64)
Title:
Job Family ID
Job family identifier of the responsibility. -
JobFamilyName: string
Title:
Job Family
Read Only:true
Maximum Length:240
Job family name of the responsibility. -
JobFunctionCode: string
Title:
Job Function Code
Maximum Length:30
Job function code of the responsibility. -
JobFunctionMeaning: string
Title:
Job Function
Read Only:true
Maximum Length:80
Description of the responsibility's job function. -
JobId: integer
(int64)
Title:
Job ID
Job identifier of the responsibility. -
JobName: string
Title:
Job
Read Only:true
Maximum Length:240
Job name of the responsibility. -
JobSetCode: string
Title:
Job Set Code
Maximum Length:30
Job set code of the responsibility. -
LastNameEnd: string
Title:
To Last Name
Maximum Length:30
Last name ending range of the responsibility. -
LastNameStart: string
Title:
From Last Name
Maximum Length:30
Last name starting range of the responsibility. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the responsibility was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the responsibility. -
LegalEmployerName: string
Title:
Legal Employer
Maximum Length:240
Legal employer name of the responsibility. -
LegalEntityId: integer
(int64)
Title:
Legal Entity ID
Legal entity identifier of the responsibility. -
LegislativeDataGroupId: integer
(int64)
Title:
Legislative Data Group ID
Legislative data group identifier of the responsibility. -
LegislativeDataGroupName: string
Title:
Legislative Data Group
Maximum Length:240
Legislative data group name of the responsibility. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationCode: string
Title:
Location Code
Maximum Length:150
Location code of the responsibility. -
LocationId: integer
(int64)
Title:
Location ID
Location identifier of the responsibility. -
LocationName: string
Title:
Location
Read Only:true
Maximum Length:60
Location name of the responsibility. -
LocationSetCode: string
Title:
Location Set Code
Maximum Length:30
Location set code of the responsibility. -
OrganizationTreeCode: string
Title:
Organization Tree Code
Maximum Length:30
Organization tree code of the responsibility. -
OrganizationTreeName: string
Title:
Organization Hierarchy
Read Only:true
Maximum Length:80
Organization tree name of the responsibility. -
OrganizationTreeVersionId: string
Title:
Organization Tree Version ID
Maximum Length:32
Organization tree version identifier of the responsibility. -
OrganizationTreeVersionName: string
Title:
Organization Tree Version Name
Read Only:true
Maximum Length:80
Organization tree version name of the responsibility. -
PayrollId: integer
(int64)
Title:
Payroll ID
Payroll identifier of the responsibility. -
PayrollName: string
Title:
Payroll Name
Maximum Length:80
Payroll name of the responsibility. -
PayrollStatUnitId: integer
(int64)
Title:
Payroll Statutory Unit ID
Payroll statutory unit identifier of the responsibility. -
PayrollStatutoryUnitName: string
Title:
Payroll Statutory Unit
Maximum Length:240
Payroll statutory unit name of the responsibility. -
PersonId: integer
(int64)
Title:
Person ID
Person identifier of the representative. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the representative. -
PositionCode: string
Title:
Position Code
Maximum Length:30
Position code of the responsibility. -
PositionId: integer
(int64)
Title:
Position ID
Position identifier of the responsibility. -
PositionName: string
Title:
Position
Read Only:true
Maximum Length:240
Position name of the responsibility. -
PositionTreeCode: string
Title:
Position Tree Code
Maximum Length:30
Position tree code of the responsibility. -
PositionTreeName: string
Title:
Position Hierarchy
Read Only:true
Maximum Length:80
Position tree name of the responsibility. -
PositionTreeVersionId: string
Title:
Position Tree Version ID
Maximum Length:32
Position tree version identifier of the responsibility. -
PositionTreeVersionName: string
Title:
Position Tree Version Name
Read Only:true
Maximum Length:80
Position tree version name of the responsibility. -
RecruitingLocHierarchyId: integer
(int64)
Title:
Recruiting Location Hierarchy ID
Recruiting location hierarchy identifier of the responsibility. -
RecruitingLocHierarchyName: string
Title:
Recruiting Location Hierarchy
Maximum Length:4000
Recruiting location hierarchy name of the responsibility. -
RecruitingOrgHierarchyId: integer
(int64)
Title:
Recruiting Organization Hierarchy ID
Recruiting organization hierarchy identifier of the responsibility. -
RecruitingOrgHierarchyName: string
Title:
Recruiting Organization Hierarchy
Maximum Length:240
Recruiting organization hierarchy name of the responsibility. -
RecruitingOrgTreeCode: string
Title:
Recruiting Organization Tree Code
Maximum Length:1000
Recruiting organization tree code of the responsibility. -
RecruitingOrgTreeVer: string
Title:
Recruiting Organization Tree Version
Maximum Length:1000
Recruiting organization tree version of the responsibility. -
RecruitingTypeCode: string
Title:
Recruiting Type Code
Maximum Length:30
Recruiting type code of the responsibility. -
RecruitingTypeMeaning: string
Title:
Recruiting Type
Read Only:true
Maximum Length:80
Description of the responsibility's recruiting type. -
ResponsibilityId: integer
(int64)
Title:
Area of Responsibility ID
Read Only:true
Identifier of the responsibility. -
ResponsibilityName: string
Title:
Responsibility Name
Maximum Length:240
Name of the responsibility. -
ResponsibilityType: string
Title:
Responsibility Type Code
Maximum Length:30
Type of the responsibility. -
ResponsibilityTypeMeaning: string
Title:
Responsibility Type
Read Only:true
Maximum Length:80
Description of the responsibility's representative type. -
StartDate: string
(date)
Title:
From Date
Start date of the responsibility. -
TaxReportingUnitId: integer
(int64)
Title:
Tax Reporting Unit ID
Tax reporting unit identifier of the responsibility. -
TaxReportingUnitName: string
Title:
Tax Reporting Unit
Maximum Length:240
Tax reporting unit name of the responsibility. -
TemplateCode: string
Title:
Template Code
Maximum Length:30
Description of the responsibility template code that's associated to this responsibility. -
TemplateId: integer
(int64)
Title:
Template ID
Responsibility template identifier associated to this responsibility. -
TemplateName: string
Title:
Template Name
Read Only:true
Maximum Length:240
Responsibility template name associated to this responsibility. -
TopDepartmentId: integer
(int64)
Title:
Top Department ID
Top department identifier of the responsibility. -
TopDepartmentName: string
Title:
Top Department
Maximum Length:240
Top department name of the responsibility. -
TopManagerId: integer
(int64)
Title:
Top Manager ID
Top manager identifier of the responsibility. -
TopManagerName: string
Title:
Top Manager
Read Only:true
Maximum Length:240
Top manager name of the responsibility. -
TopManagerNumber: string
Title:
Top Manager Number
Maximum Length:30
Surrogate identifier for the top manager. -
TopOrganizationId: integer
(int64)
Title:
Top Organization ID
Top organization identifier of the responsibility. -
TopOrganizationName: string
Title:
Top Organization
Maximum Length:240
Top organization name of the responsibility. -
TopPositionId: integer
(int64)
Title:
Top Position ID
Top position identifier of the responsibility. -
TopPositionName: string
Title:
Top Position
Maximum Length:240
Top position name of the responsibility. -
Usage: string
Title:
Usage
Maximum Length:4000
Value of the responsibility's usage. It can contain multiple comma-separated values, such as ORA_PER_AOR_APPROVAL and ORA_PER_AOR_CHECKLIST. -
WorkContactsFlag: boolean
Title:
Work Contacts Flag
Maximum Length:30
Default Value:true
Work contact of the responsibility, such as include or exclude.
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.
Links
- findByAdvancedSearch
-
Finds areas of responsibility records that match the specified advance search criteria. This returns the filtered records.
- getAorScopeDetails
-
Gets the responsibility template's scope details when creating a responsibility from a template.