Create an area of responsibility
post
/hcmRestApi/resources/11.13.18.05/areasOfResponsibility
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActiveStatus(required): string
Title:
Status
Maximum Length:30
Status of the area of responsibility whether active or inactive. -
AssignmentCategory: string
Title:
Assignment Category Code
Maximum Length:30
Code of the assignment category, which is used in defining the responsibility scope. -
AssignmentId(required): integer
(int64)
Title:
Assignment ID
Unique identifier of the assignment assigned to the area of responsibility. -
AssignmentNumber: string
Title:
Assignment Number
Maximum Length:30
Unique number of the assignment assigned to the area of responsibility. -
bannerOverrideMessages: array
Banner Override Messages
Title:
Banner Override Messages
The bannerOverrideMessages resource provides all the status information and related messages for an object. -
BargainingUnitCode: string
Title:
Bargaining Unit Code
Maximum Length:30
Code of the bargaining unit, which is used in defining the responsibility scope. -
BenefitGroupId: integer
(int64)
Title:
Benefit Group ID
Surrogate identifier for the benefit group, which is used in defining the responsibility scope. -
BenefitGroupName: string
Title:
Benefit Group
Maximum Length:240
Name of the benefit group, which is used in defining the responsibility scope. -
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Unique identifier for the business unit, which is used in defining the responsibility scope. -
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Short code of the business unit, which is used in defining the responsibility scope. -
CountryCode: string
Title:
Country Code
Maximum Length:30
Code of the country, which is used for defining the responsibility scope, such as US. -
DepartmentId: integer
(int64)
Title:
Department ID
Unique identifier for the department, which is used in defining the responsibility scope. -
DepartmentName: string
Title:
Department
Maximum Length:240
Name of the department, which is used in defining the responsibility scope. -
DepartmentTreeCode: string
Title:
Department Tree Code
Maximum Length:30
Code of the department tree code, which is used in defining the responsibility scope. -
DepartmentTreeVersionId: string
Title:
Department Tree Version ID
Maximum Length:32
Unique identifier for the department tree version, which is used in defining the responsibility scope. -
EndDate: string
(date)
Title:
To Date
Date when the area of responsibility is last active. -
GradeCode: string
Title:
Grade Code
Maximum Length:30
Code of the grade, which is used in defining the responsibility scope. -
GradeId: integer
(int64)
Title:
Grade ID
Unique identifier for the grade, which is used in defining the responsibility scope. -
GradeSetCode: string
Title:
Grade Set Code
Maximum Length:30
Code of the grade set, which is used in defining the responsibility scope. -
HierarchyLevels: integer
(int32)
Title:
Hierarchy Levels
Number of levels in the hierarchy, which is used in defining the responsibility scope. -
HierarchyType: string
Title:
Hierarchy Type Code
Maximum Length:30
Code of the hierarchy type, which is used in defining the responsibility scope. -
IncludeTopHierNodeFlag: boolean
Title:
Include Top Hierarchy Node
Maximum Length:30
Indicates whether the top organization, department, position, or supervisor is included in the hierarchy, which is used in defining the responsibility scope. The default value is N. -
JobCode: string
Title:
Job Code
Maximum Length:30
Code of the job, which is used in defining the responsibility scope. -
JobFamilyCode: string
Title:
Job Family Code
Maximum Length:240
Code of the job family, which is used in defining the responsibility scope. -
JobFamilyId: integer
(int64)
Title:
Job Family ID
Unique identifier for the job family, which is used in defining the responsibility scope. -
JobFunctionCode: string
Title:
Job Function Code
Maximum Length:30
Code of the job function, which is used in defining the responsibility scope. -
JobId: integer
(int64)
Title:
Job ID
Unique identifier for the job, which is used in defining the responsibility scope. -
JobSetCode: string
Title:
Job Set Code
Maximum Length:30
Code of the job set, which is used in defining the responsibility scope. -
LastNameEnd: string
Title:
To Last Name
Maximum Length:30
Initial letter of the last name in the last name range. This is used in defining the responsibility scope. This value is supplied with LastNameStart. -
LastNameStart: string
Title:
From Last Name
Maximum Length:30
Initial letter of the last name in the last name range. This is used in defining the responsibility scope. This value is supplied with LastNameEnd. -
LegalEmployerName: string
Title:
Legal Employer
Maximum Length:240
Name of the legal employer, which is used in defining the responsibility scope. -
LegalEntityId: integer
(int64)
Title:
Legal Entity ID
Surrogate identifier for the legal entity, which is used in defining the responsibility scope. -
LegislativeDataGroupId: integer
(int64)
Title:
Legislative Data Group ID
Unique identifier for the legislative data group, which is used in defining the responsibility scope. -
LegislativeDataGroupName: string
Title:
Legislative Data Group
Maximum Length:240
Name of the legislative data group, which is used in defining the responsibility scope. -
LocationCode: string
Title:
Location Code
Maximum Length:150
Code of the location, which is used in defining the responsibility scope. -
LocationId: integer
(int64)
Title:
Location ID
Unique identifier for the location, which is used in defining the responsibility scope. -
LocationSetCode: string
Title:
Location Set Code
Maximum Length:30
Code of the location set, which is used in defining the responsibility scope. -
OrganizationTreeCode: string
Title:
Organization Tree Code
Maximum Length:30
Code of the organization tree, which is used in defining the responsibility scope. -
OrganizationTreeVersionId: string
Title:
Organization Tree Version ID
Maximum Length:32
Unique identifier for the organization tree version, which is used in defining the responsibility scope. -
PayrollId: integer
(int64)
Title:
Payroll ID
Unique identifier for the payroll, which is used in defining the responsibility scope. -
PayrollName: string
Title:
Payroll Name
Maximum Length:80
Name of the payroll, which is used in defining the responsibility scope. -
PayrollStatUnitId: integer
(int64)
Title:
Payroll Statutory Unit ID
Unique identifier for the payroll statutory unit, which is used in defining the responsibility scope. -
PayrollStatutoryUnitName: string
Title:
Payroll Statutory Unit
Maximum Length:240
Name of the payroll statutory unit, which is used in defining the responsibility scope. -
PersonId(required): integer
(int64)
Title:
Person ID
Unique identifier of the person who is assigned to the responsibility. -
PositionCode: string
Title:
Position Code
Maximum Length:30
Code of the position, which is used in defining the responsibility scope. -
PositionId: integer
(int64)
Title:
Position ID
Unique identifier for the position, which is used in defining the responsibility scope. -
PositionTreeCode: string
Title:
Position Tree Code
Maximum Length:30
Code of the position tree, which is used in defining the responsibility scope. -
PositionTreeVersionId: string
Title:
Position Tree Version ID
Maximum Length:32
Unique identifier for the position tree version, which is used in defining the responsibility scope. -
RecruitingLocHierarchyId: integer
(int64)
Title:
Recruiting Location Hierarchy ID
Surrogate identifier of the recruiting location hierarchy, which is used in defining the responsibility scope. -
RecruitingLocHierarchyName: string
Title:
Recruiting Location Hierarchy
Maximum Length:4000
Name of the recruiting location hierarchy, which is used in defining the responsibility scope. -
RecruitingOrgHierarchyId: integer
(int64)
Title:
Recruiting Organization Hierarchy ID
Surrogate identifier of the recruiting organization hierarchy, which is used in defining the responsibility scope. -
RecruitingOrgHierarchyName: string
Title:
Recruiting Organization Hierarchy
Maximum Length:240
Name of the recruiting organization hierarchy, which is used in defining the responsibility scope. -
RecruitingOrgTreeCode: string
Title:
Recruiting Organization Tree Code
Maximum Length:1000
Code of the recruiting organization tree, which is used in defining the responsibility scope. -
RecruitingOrgTreeVer: string
Title:
Recruiting Organization Tree Version
Maximum Length:1000
Version of the recruiting organization hierarchy, which is used in defining the responsibility scope. -
RecruitingTypeCode: string
Title:
Recruiting Type Code
Maximum Length:30
Code of the recruiting type, which is used in defining the responsibility scope. -
ResponsibilityName(required): string
Title:
Responsibility Name
Maximum Length:240
Name of the responsibility. -
ResponsibilityType(required): string
Title:
Responsibility Type Code
Maximum Length:30
Code that uniquely references the responsibility type. -
StartDate(required): string
(date)
Title:
From Date
Date when the area of responsibility is active. -
TaxReportingUnitId: integer
(int64)
Title:
Tax Reporting Unit ID
Unique identifier for the tax reporting unit, which is used in defining the responsibility scope. -
TaxReportingUnitName: string
Title:
Tax Reporting Unit
Maximum Length:240
Name of the tax reporting unit, which is used in defining the responsibility scope. -
TemplateCode: string
Title:
Template Code
Maximum Length:30
Code of the area of responsibility template. -
TemplateId: integer
(int64)
Title:
Template ID
Unique identifier of the area of responsibility template. -
TopDepartmentId: integer
(int64)
Title:
Top Department ID
Unique identifier for the top department in the department hierarchy, which is used in defining the responsibility scope. -
TopDepartmentName: string
Title:
Top Department
Maximum Length:240
Name of the top department in the hierarchy, which is used in defining the responsibility scope. -
TopManagerId: integer
(int64)
Title:
Top Manager ID
Unique identifier for the top manager in the supervisor hierarchy, which is used in defining the responsibility scope. -
TopManagerNumber: string
Title:
Top Manager Number
Maximum Length:30
Person number of the top manager in the supervisor hierarchy, which is used in defining the responsibility scope. -
TopOrganizationId: integer
(int64)
Title:
Top Organization ID
Unique identifier for the top organization in the organization hierarchy, which is used in defining the responsibility scope. -
TopOrganizationName: string
Title:
Top Organization
Maximum Length:240
Name of the top organization in the hierarchy for the responsibility scope. -
TopPositionId: integer
(int64)
Title:
Top Position ID
Unique identifier for the top position in the position hierarchy, which is used in defining the responsibility scope. -
TopPositionName: string
Title:
Top Position
Maximum Length:240
Name of the top position in the hierarchy, which is used in defining the responsibility scope. -
Usage: string
Title:
Usage
Maximum Length:4000
Intended purpose for the responsibility. -
WorkContactsFlag: boolean
Title:
Work Contacts Flag
Maximum Length:30
Default Value:true
Indicates whether to include or exclude the person from work contacts or representatives. The default value is Yes.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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-item-response
Type:
Show Source
object
-
ActiveStatus: string
Title:
Status
Maximum Length:30
Status of the area of responsibility whether active or inactive. -
AssignmentCategory: string
Title:
Assignment Category Code
Maximum Length:30
Code of the assignment category, which is used in defining the responsibility scope. -
AssignmentCategoryMeaning: string
Title:
Assignment Category
Read Only:true
Maximum Length:80
Category of the assignment, which is used in defining the responsibility scope. -
AssignmentId: integer
(int64)
Title:
Assignment ID
Unique identifier of the assignment assigned to the area of responsibility. -
AssignmentName: string
Title:
Business Title
Read Only:true
Maximum Length:80
Business title of the person assigned to the responsibility. -
AssignmentNumber: string
Title:
Assignment Number
Maximum Length:30
Unique number of the assignment assigned to the area of responsibility. -
bannerOverrideMessages: array
Banner Override Messages
Title:
Banner Override Messages
The bannerOverrideMessages resource provides all the status information and related messages for an object. -
BargainingUnit: string
Title:
Bargaining Unit
Read Only:true
Maximum Length:80
Name of the bargaining unit, which is used in defining the responsibility scope. -
BargainingUnitCode: string
Title:
Bargaining Unit Code
Maximum Length:30
Code of the bargaining unit, which is used in defining the responsibility scope. -
BenefitGroupId: integer
(int64)
Title:
Benefit Group ID
Surrogate identifier for the benefit group, which is used in defining the responsibility scope. -
BenefitGroupName: string
Title:
Benefit Group
Maximum Length:240
Name of the benefit group, which is used in defining the responsibility scope. -
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Unique identifier for the business unit, which is used in defining the responsibility scope. -
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Short code of the business unit, which is used in defining the responsibility scope. -
Country: string
Title:
Country
Read Only:true
Maximum Length:80
Name of the country, which is used in defining the responsibility scope. -
CountryCode: string
Title:
Country Code
Maximum Length:30
Code of the country, which is used for defining the responsibility scope, such as US. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the area of responsibility. -
CreationDate: string
(date-time)
Read Only:
true
Date when the area of responsibility was created. -
DepartmentId: integer
(int64)
Title:
Department ID
Unique identifier for the department, which is used in defining the responsibility scope. -
DepartmentName: string
Title:
Department
Maximum Length:240
Name of the department, which is used in defining the responsibility scope. -
DepartmentTreeCode: string
Title:
Department Tree Code
Maximum Length:30
Code of the department tree code, which is used in defining the responsibility scope. -
DepartmentTreeName: string
Title:
Department Hierarchy
Read Only:true
Maximum Length:80
Name of the department hierarchy, which is used in defining the responsibility scope. -
DepartmentTreeVersionId: string
Title:
Department Tree Version ID
Maximum Length:32
Unique identifier for the department tree version, which is used in defining the responsibility scope. -
DepartmentTreeVersionName: string
Title:
Department Tree Version Name
Read Only:true
Maximum Length:80
Name of the department hierarchy version, which is used in defining the responsibility scope. -
DisplayName: string
Title:
Person Name
Read Only:true
Maximum Length:240
Name of the person who is assigned to the responsibility. -
EndDate: string
(date)
Title:
To Date
Date when the area of responsibility is last active. -
GradeCode: string
Title:
Grade Code
Maximum Length:30
Code of the grade, which is used in defining the responsibility scope. -
GradeId: integer
(int64)
Title:
Grade ID
Unique identifier for the grade, which is used in defining the responsibility scope. -
GradeName: string
Title:
Grade
Read Only:true
Maximum Length:240
Name of the grade, which is used in defining the responsibility scope. -
GradeSetCode: string
Title:
Grade Set Code
Maximum Length:30
Code of the grade set, which is used in defining the responsibility scope. -
HierarchyLevels: integer
(int32)
Title:
Hierarchy Levels
Number of levels in the hierarchy, which is used in defining the responsibility scope. -
HierarchyType: string
Title:
Hierarchy Type Code
Maximum Length:30
Code of the hierarchy type, which is used in defining the responsibility scope. -
HierarchyTypeMeaning: string
Title:
Hierarchy Type
Read Only:true
Maximum Length:80
Name of the hierarchy type, which is used in defining the responsibility scope. -
IncludeTopHierNodeFlag: boolean
Title:
Include Top Hierarchy Node
Maximum Length:30
Indicates whether the top organization, department, position, or supervisor is included in the hierarchy, which is used in defining the responsibility scope. The default value is N. -
JobCode: string
Title:
Job Code
Maximum Length:30
Code of the job, which is used in defining the responsibility scope. -
JobFamilyCode: string
Title:
Job Family Code
Maximum Length:240
Code of the job family, which is used in defining the responsibility scope. -
JobFamilyId: integer
(int64)
Title:
Job Family ID
Unique identifier for the job family, which is used in defining the responsibility scope. -
JobFamilyName: string
Title:
Job Family
Read Only:true
Maximum Length:240
Name of the job family, which is used in defining the responsibility scope. The job family code can also be used instead. -
JobFunctionCode: string
Title:
Job Function Code
Maximum Length:30
Code of the job function, which is used in defining the responsibility scope. -
JobFunctionMeaning: string
Title:
Job Function
Read Only:true
Maximum Length:80
Meaning of the job function code. -
JobId: integer
(int64)
Title:
Job ID
Unique identifier for the job, which is used in defining the responsibility scope. -
JobName: string
Title:
Job
Read Only:true
Maximum Length:240
Name of the job, which is used in defining the responsibility scope. -
JobSetCode: string
Title:
Job Set Code
Maximum Length:30
Code of the job set, which is used in defining the responsibility scope. -
LastNameEnd: string
Title:
To Last Name
Maximum Length:30
Initial letter of the last name in the last name range. This is used in defining the responsibility scope. This value is supplied with LastNameStart. -
LastNameStart: string
Title:
From Last Name
Maximum Length:30
Initial letter of the last name in the last name range. This is used in defining the responsibility scope. This value is supplied with LastNameEnd. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the area of responsibility was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the area of responsibility. -
LegalEmployerName: string
Title:
Legal Employer
Maximum Length:240
Name of the legal employer, which is used in defining the responsibility scope. -
LegalEntityId: integer
(int64)
Title:
Legal Entity ID
Surrogate identifier for the legal entity, which is used in defining the responsibility scope. -
LegislativeDataGroupId: integer
(int64)
Title:
Legislative Data Group ID
Unique identifier for the legislative data group, which is used in defining the responsibility scope. -
LegislativeDataGroupName: string
Title:
Legislative Data Group
Maximum Length:240
Name of the legislative data group, which is used in defining the responsibility scope. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationCode: string
Title:
Location Code
Maximum Length:150
Code of the location, which is used in defining the responsibility scope. -
LocationId: integer
(int64)
Title:
Location ID
Unique identifier for the location, which is used in defining the responsibility scope. -
LocationName: string
Title:
Location
Read Only:true
Maximum Length:60
Name of the location, which is used in defining the responsibility scope. -
LocationSetCode: string
Title:
Location Set Code
Maximum Length:30
Code of the location set, which is used in defining the responsibility scope. -
OrganizationTreeCode: string
Title:
Organization Tree Code
Maximum Length:30
Code of the organization tree, which is used in defining the responsibility scope. -
OrganizationTreeName: string
Title:
Organization Hierarchy
Read Only:true
Maximum Length:80
Name of the organization hierarchy, which is used in defining the responsibility scope. -
OrganizationTreeVersionId: string
Title:
Organization Tree Version ID
Maximum Length:32
Unique identifier for the organization tree version, which is used in defining the responsibility scope. -
OrganizationTreeVersionName: string
Title:
Organization Tree Version Name
Read Only:true
Maximum Length:80
Name of the organization hierarchy version, which is used in defining the responsibility scope. -
PayrollId: integer
(int64)
Title:
Payroll ID
Unique identifier for the payroll, which is used in defining the responsibility scope. -
PayrollName: string
Title:
Payroll Name
Maximum Length:80
Name of the payroll, which is used in defining the responsibility scope. -
PayrollStatUnitId: integer
(int64)
Title:
Payroll Statutory Unit ID
Unique identifier for the payroll statutory unit, which is used in defining the responsibility scope. -
PayrollStatutoryUnitName: string
Title:
Payroll Statutory Unit
Maximum Length:240
Name of the payroll statutory unit, which is used in defining the responsibility scope. -
PersonId: integer
(int64)
Title:
Person ID
Unique identifier of the person who is assigned to the responsibility. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Unique number of the person who is assigned to the responsibility. -
PositionCode: string
Title:
Position Code
Maximum Length:30
Code of the position, which is used in defining the responsibility scope. -
PositionId: integer
(int64)
Title:
Position ID
Unique identifier for the position, which is used in defining the responsibility scope. -
PositionName: string
Title:
Position
Read Only:true
Maximum Length:240
Name of the position, which is used in defining the responsibility scope. -
PositionTreeCode: string
Title:
Position Tree Code
Maximum Length:30
Code of the position tree, which is used in defining the responsibility scope. -
PositionTreeName: string
Title:
Position Hierarchy
Read Only:true
Maximum Length:80
Name of the position hierarchy, which is used in defining the responsibility scope. -
PositionTreeVersionId: string
Title:
Position Tree Version ID
Maximum Length:32
Unique identifier for the position tree version, which is used in defining the responsibility scope. -
PositionTreeVersionName: string
Title:
Position Tree Version Name
Read Only:true
Maximum Length:80
Name of the position hierarchy version, which is used in defining the responsibility scope. -
RecruitingLocHierarchyId: integer
(int64)
Title:
Recruiting Location Hierarchy ID
Surrogate identifier of the recruiting location hierarchy, which is used in defining the responsibility scope. -
RecruitingLocHierarchyName: string
Title:
Recruiting Location Hierarchy
Maximum Length:4000
Name of the recruiting location hierarchy, which is used in defining the responsibility scope. -
RecruitingOrgHierarchyId: integer
(int64)
Title:
Recruiting Organization Hierarchy ID
Surrogate identifier of the recruiting organization hierarchy, which is used in defining the responsibility scope. -
RecruitingOrgHierarchyName: string
Title:
Recruiting Organization Hierarchy
Maximum Length:240
Name of the recruiting organization hierarchy, which is used in defining the responsibility scope. -
RecruitingOrgTreeCode: string
Title:
Recruiting Organization Tree Code
Maximum Length:1000
Code of the recruiting organization tree, which is used in defining the responsibility scope. -
RecruitingOrgTreeVer: string
Title:
Recruiting Organization Tree Version
Maximum Length:1000
Version of the recruiting organization hierarchy, which is used in defining the responsibility scope. -
RecruitingTypeCode: string
Title:
Recruiting Type Code
Maximum Length:30
Code of the recruiting type, which is used in defining the responsibility scope. -
RecruitingTypeMeaning: string
Title:
Recruiting Type
Read Only:true
Maximum Length:80
Name of the recruiting type, which is used in defining the responsibility scope. -
ResponsibilityId: integer
(int64)
Title:
Area of Responsibility ID
Read Only:true
Unique identifier for the area of responsibility. This is available only when updating an existing record. -
ResponsibilityName: string
Title:
Responsibility Name
Maximum Length:240
Name of the responsibility. -
ResponsibilityType: string
Title:
Responsibility Type Code
Maximum Length:30
Code that uniquely references the responsibility type. -
ResponsibilityTypeMeaning: string
Title:
Responsibility Type
Read Only:true
Maximum Length:80
Type of responsibility, such as human resources representative or union representative. -
StartDate: string
(date)
Title:
From Date
Date when the area of responsibility is active. -
TaxReportingUnitId: integer
(int64)
Title:
Tax Reporting Unit ID
Unique identifier for the tax reporting unit, which is used in defining the responsibility scope. -
TaxReportingUnitName: string
Title:
Tax Reporting Unit
Maximum Length:240
Name of the tax reporting unit, which is used in defining the responsibility scope. -
TemplateCode: string
Title:
Template Code
Maximum Length:30
Code of the area of responsibility template. -
TemplateId: integer
(int64)
Title:
Template ID
Unique identifier of the area of responsibility template. -
TemplateName: string
Title:
Template Name
Read Only:true
Maximum Length:240
Name of the area of responsibility template. -
TopDepartmentId: integer
(int64)
Title:
Top Department ID
Unique identifier for the top department in the department hierarchy, which is used in defining the responsibility scope. -
TopDepartmentName: string
Title:
Top Department
Maximum Length:240
Name of the top department in the hierarchy, which is used in defining the responsibility scope. -
TopManagerId: integer
(int64)
Title:
Top Manager ID
Unique identifier for the top manager in the supervisor hierarchy, which is used in defining the responsibility scope. -
TopManagerName: string
Title:
Top Manager
Read Only:true
Maximum Length:240
Name of the top manager, which is used in defining the responsibility scope. -
TopManagerNumber: string
Title:
Top Manager Number
Maximum Length:30
Person number of the top manager in the supervisor hierarchy, which is used in defining the responsibility scope. -
TopOrganizationId: integer
(int64)
Title:
Top Organization ID
Unique identifier for the top organization in the organization hierarchy, which is used in defining the responsibility scope. -
TopOrganizationName: string
Title:
Top Organization
Maximum Length:240
Name of the top organization in the hierarchy for the responsibility scope. -
TopPositionId: integer
(int64)
Title:
Top Position ID
Unique identifier for the top position in the position hierarchy, which is used in defining the responsibility scope. -
TopPositionName: string
Title:
Top Position
Maximum Length:240
Name of the top position in the hierarchy, which is used in defining the responsibility scope. -
Usage: string
Title:
Usage
Maximum Length:4000
Intended purpose for the responsibility. -
WorkContactsFlag: boolean
Title:
Work Contacts Flag
Maximum Length:30
Default Value:true
Indicates whether to include or exclude the person from work contacts or representatives. The default value is Yes.
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
- AssignmentCategoryLovVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{AssignmentCategory}%2CLookupType%3DEMP_CAT
The following properties are defined on the LOV link relation:- Source Attribute: AssignmentCategory; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- BargainingUnitLovVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{BargainingUnitCode}%2CLookupType%3DBARGAINING_UNIT_CODE
The following properties are defined on the LOV link relation:- Source Attribute: BargainingUnitCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- BenefitGroupsLovVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: BenefitGroupName; Target Attribute: BenefitGroupName
- Display Attribute: BenefitGroupName
- BusinessUnitLovVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: BusinessUnitName; Target Attribute: Name
- Display Attribute: Name
- CountryLovVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: CountryCode; Target Attribute: TerritoryCode
- Display Attribute: CountryName
- DepartmentLovVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: DepartmentName; Target Attribute: Name
- Display Attribute: Name
- DepartmentTreeLOVVA
-
Parameters:
- finder:
findByWord%3BTreeStructureCode%3DPER_DEPT_TREE_STRUCTURE
The following properties are defined on the LOV link relation:- Source Attribute: DepartmentTreeCode; Target Attribute: TreeCode
- Display Attribute: TreeName
- finder:
- GeographyHiringPVOVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: RecruitingLocHierarchyName; Target Attribute: GeographyName
- Display Attribute: GeographyName
- GradeSetLovVA
-
Operation: /hcmRestApi/resources/11.13.18.05/hcmSetsLOVThe following properties are defined on the LOV link relation:
- Source Attribute: GradeSetCode; Target Attribute: SetCode
- Display Attribute: SetName
- GradeVA
-
Operation: /hcmRestApi/resources/11.13.18.05/gradesLovThe following properties are defined on the LOV link relation:
- Source Attribute: GradeCode; Target Attribute: GradeCode
- Display Attribute: Name
- HierarchyTypeLovVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{HierarchyType}%2CLookupType%3DORA_PER_AOR_HIERARCHY_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: HierarchyType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- JobFamilyLovVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: JobFamilyCode; Target Attribute: JobFamilyCode
- Display Attribute: JobFamilyName
- JobFunctionLovVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{JobFunctionCode}%2CLookupType%3DJOB_FUNCTION_CODE
The following properties are defined on the LOV link relation:- Source Attribute: JobFunctionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- JobSetLovVA
-
Operation: /hcmRestApi/resources/11.13.18.05/hcmSetsLOVThe following properties are defined on the LOV link relation:
- Source Attribute: JobSetCode; Target Attribute: SetCode
- Display Attribute: SetName
- JobVA
-
Operation: /hcmRestApi/resources/11.13.18.05/jobsLovThe following properties are defined on the LOV link relation:
- Source Attribute: JobCode; Target Attribute: JobCode
- Display Attribute: JobName
- LegalEmployerLovVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: LegalEmployerName; Target Attribute: Name
- Display Attribute: Name
- LegislativeDataGroupLovVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: LegislativeDataGroupName; Target Attribute: Name
- Display Attribute: Name
- LocationSetLovVA
-
Operation: /hcmRestApi/resources/11.13.18.05/hcmSetsLOVThe following properties are defined on the LOV link relation:
- Source Attribute: LocationSetCode; Target Attribute: SetCode
- Display Attribute: SetName
- LocationVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: LocationCode; Target Attribute: LocationCode
- Display Attribute: LocationName
- OrganizationHiringPVOVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: RecruitingOrgHierarchyName; Target Attribute: Name
- Display Attribute: Name
- OrganizationTreeLOVVA
-
Parameters:
- finder:
findByWord%3BTreeStructureCode%3DPER_ORG_TREE_STRUCTURE
The following properties are defined on the LOV link relation:- Source Attribute: OrganizationTreeCode; Target Attribute: TreeCode
- Display Attribute: TreeName
- finder:
- PayrollStatuatoryUnitVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: PayrollStatutoryUnitName; Target Attribute: PayrollStatutoryUnitName
- Display Attribute: PayrollStatutoryUnitName
- PayrollVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: PayrollName; Target Attribute: PayrollName
- Display Attribute: PayrollName
- PositionLovVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: PositionCode; Target Attribute: PositionCode
- Display Attribute: PositionName
- PositionTreeLOVVA
-
Parameters:
- finder:
findByWord%3BTreeStructureCode%3DPER_POS_TREE_STRUCTURE
The following properties are defined on the LOV link relation:- Source Attribute: PositionTreeCode; Target Attribute: TreeCode
- Display Attribute: TreeName
- finder:
- RecruitingTypeLovVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{RecruitingTypeCode}%2CLookupType%3DORA_IRC_RECRUITING_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: RecruitingTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ResponsibilityStatusVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{ActiveStatus}%2CLookupType%3DACTIVE_INACTIVE
The following properties are defined on the LOV link relation:- Source Attribute: ActiveStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ResponsibilityTemplatesLovVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: TemplateCode; Target Attribute: Code
- Display Attribute: Name
- ResponsibilityTypeLovVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{ResponsibilityType}%2CLookupType%3DPER_RESPONSIBILITY_TYPES
The following properties are defined on the LOV link relation:- Source Attribute: ResponsibilityType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TaxReportingUnitVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: TaxReportingUnitName; Target Attribute: TaxReportingUnitName
- Display Attribute: TaxReportingUnitName
- TopDepartmentTreeLOVVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: TopDepartmentName; Target Attribute: DepartmentName
- Display Attribute: DepartmentName
- TopOrganizationTreeLOVVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: TopOrganizationName; Target Attribute: OrganizationName
- Display Attribute: OrganizationName
- TopPositionTreeLOVVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: TopPositionName; Target Attribute: PositionName
- Display Attribute: PositionName
- bannerOverrideMessages
-
Parameters:
- areasOfResponsibilityUniqID:
$request.path.areasOfResponsibilityUniqID
The bannerOverrideMessages resource provides all the status information and related messages for an object. - areasOfResponsibilityUniqID:
- reassign
-
Parameters:
- areasOfResponsibilityUniqID:
$request.path.areasOfResponsibilityUniqID
Reassigns an area of responsibility to a different worker. - areasOfResponsibilityUniqID: