Jump to

• Request
• Response

Get an area of responsibility

get

/hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}

Request

Path Parameters

• areasOfResponsibilityUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Areas of Responsibility resource and used to uniquely identify an instance of Areas of Responsibility. The client should not generate the hash key value. Instead, the client should query on the Areas of Responsibility collection resource in order to navigate to a specific instance of Areas of Responsibility to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

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.

Body ()

Root Schema : areasOfResponsibility-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the area of responsibility was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BenefitGroupId":{
            "title":"Benefit Group ID",
            "type":"integer",
            "description":"Surrogate identifier for the benefit group, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PositionTreeCode":{
            "title":"Position Tree Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the position tree, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RecruitingLocHierarchyId":{
            "title":"Recruiting Location Hierarchy ID",
            "type":"integer",
            "description":"Surrogate identifier of the recruiting location hierarchy, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkContactsFlag":{
            "title":"Work Contacts Flag",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether to include or exclude the person from work contacts or representatives. The default value is Yes.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastNameStart":{
            "title":"From Last Name",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "TopDepartmentName":{
            "title":"Top Department",
            "maxLength":240,
            "type":"string",
            "description":"Name of the top department in the hierarchy, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "TopPositionId":{
            "title":"Top Position ID",
            "type":"integer",
            "description":"Unique identifier for the top position in the position hierarchy, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecruitingOrgHierarchyId":{
            "title":"Recruiting Organization Hierarchy ID",
            "type":"integer",
            "description":"Surrogate identifier of the recruiting organization hierarchy, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActiveStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the area of responsibility whether active or inactive.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PayrollName":{
            "title":"Payroll Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the payroll, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LegalEmployerName":{
            "title":"Legal Employer",
            "maxLength":240,
            "type":"string",
            "description":"Name of the legal employer, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PayrollStatutoryUnitName":{
            "title":"Payroll Statutory Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the payroll statutory unit, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "DepartmentTreeName":{
            "title":"Department Hierarchy",
            "maxLength":80,
            "type":"string",
            "description":"Name of the department hierarchy, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PositionCode":{
            "title":"Position Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the position, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "TaxReportingUnitId":{
            "title":"Tax Reporting Unit ID",
            "type":"integer",
            "description":"Unique identifier for the tax reporting unit, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the area of responsibility.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationSetCode":{
            "title":"Location Set Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the location set, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the area of responsibility.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationCode":{
            "title":"Location Code",
            "maxLength":150,
            "type":"string",
            "description":"Code of the location, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RecruitingOrgTreeVer":{
            "title":"Recruiting Organization Tree Version",
            "maxLength":1000,
            "type":"string",
            "description":"Version of the recruiting organization hierarchy, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-queryable":false
        },
        "TemplateCode":{
            "title":"Template Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the area of responsibility template.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GradeName":{
            "title":"Grade",
            "maxLength":240,
            "type":"string",
            "description":"Name of the grade, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier of the person who is assigned to the responsibility.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "JobFamilyCode":{
            "title":"Job Family Code",
            "maxLength":240,
            "type":"string",
            "description":"Code of the job family, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "IncludeTopHierNodeFlag":{
            "title":"Include Top Hierarchy Node",
            "maxLength":30,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "HierarchyTypeMeaning":{
            "title":"Hierarchy Type",
            "maxLength":80,
            "type":"string",
            "description":"Name of the hierarchy type, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TopManagerId":{
            "title":"Top Manager ID",
            "type":"integer",
            "description":"Unique identifier for the top manager in the supervisor hierarchy, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":80,
            "type":"string",
            "description":"Name of the country, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PositionTreeVersionId":{
            "title":"Position Tree Version ID",
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier for the position tree version, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-queryable":false
        },
        "ResponsibilityType":{
            "title":"Responsibility Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that uniquely references the responsibility type.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RecruitingTypeMeaning":{
            "title":"Recruiting Type",
            "maxLength":80,
            "type":"string",
            "description":"Name of the recruiting type, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislativeDataGroupId":{
            "title":"Legislative Data Group ID",
            "type":"integer",
            "description":"Unique identifier for the legislative data group, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DepartmentTreeVersionName":{
            "title":"Department Tree Version Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the department hierarchy version, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "JobName":{
            "title":"Job",
            "maxLength":240,
            "type":"string",
            "description":"Name of the job, which is used in defining the responsibility scope.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationName":{
            "title":"Location",
            "maxLength":60,
            "type":"string",
            "description":"Name of the location, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFamilyName":{
            "title":"Job Family",
            "maxLength":240,
            "type":"string",
            "description":"Name of the job family, which is used in defining the responsibility scope. The job family code can also be used instead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislativeDataGroupName":{
            "title":"Legislative Data Group",
            "maxLength":240,
            "type":"string",
            "description":"Name of the legislative data group, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "JobCode":{
            "title":"Job Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the job, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LegalEntityId":{
            "title":"Legal Entity ID",
            "type":"integer",
            "description":"Surrogate identifier for the legal entity, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique number of the assignment assigned to the area of responsibility.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "OrganizationTreeName":{
            "title":"Organization Hierarchy",
            "maxLength":80,
            "type":"string",
            "description":"Name of the organization hierarchy, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentCategoryMeaning":{
            "title":"Assignment Category",
            "maxLength":80,
            "type":"string",
            "description":"Category of the assignment, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TopManagerNumber":{
            "title":"Top Manager Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the top manager in the supervisor hierarchy, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PayrollId":{
            "title":"Payroll ID",
            "type":"integer",
            "description":"Unique identifier for the payroll, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique number of the person who is assigned to the responsibility.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Usage":{
            "title":"Usage",
            "maxLength":4000,
            "type":"string",
            "description":"Intended purpose for the responsibility.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TopPositionName":{
            "title":"Top Position",
            "maxLength":240,
            "type":"string",
            "description":"Name of the top position in the hierarchy, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PositionId":{
            "title":"Position ID",
            "type":"integer",
            "description":"Unique identifier for the position, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"Unique identifier for the location, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationTreeVersionId":{
            "title":"Organization Tree Version ID",
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier for the organization tree version, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-queryable":false
        },
        "ResponsibilityName":{
            "title":"Responsibility Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the responsibility.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DepartmentTreeVersionId":{
            "title":"Department Tree Version ID",
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier for the department tree version, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-queryable":false
        },
        "ResponsibilityId":{
            "title":"Area of Responsibility ID",
            "type":"integer",
            "description":"Unique identifier for the area of responsibility. This is available only when updating an existing record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"Date when the area of responsibility is last active.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TopManagerName":{
            "title":"Top Manager",
            "maxLength":240,
            "type":"string",
            "description":"Name of the top manager, which is used in defining the responsibility scope.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxReportingUnitName":{
            "title":"Tax Reporting Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the tax reporting unit, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the area of responsibility was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentTreeCode":{
            "title":"Department Tree Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the department tree code, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "bannerOverrideMessages":{
            "title":"Banner Override Messages",
            "type":"array",
            "description":"The bannerOverrideMessages resource provides all the status information and related messages for an object.",
            "items":{
                "$ref":"#/components/schemas/areasOfResponsibility-bannerOverrideMessages-item-response"
            }
        },
        "PositionTreeVersionName":{
            "title":"Position Tree Version Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the position hierarchy version, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "JobSetCode":{
            "title":"Job Set Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the job set, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "TopOrganizationName":{
            "title":"Top Organization",
            "maxLength":240,
            "type":"string",
            "description":"Name of the top organization in the hierarchy for the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date when the area of responsibility is active.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RecruitingOrgHierarchyName":{
            "title":"Recruiting Organization Hierarchy",
            "maxLength":240,
            "type":"string",
            "description":"Name of the recruiting organization hierarchy, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "GradeCode":{
            "title":"Grade Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the grade, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecruitingOrgTreeCode":{
            "title":"Recruiting Organization Tree Code",
            "maxLength":1000,
            "type":"string",
            "description":"Code of the recruiting organization tree, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-queryable":false
        },
        "PositionName":{
            "title":"Position",
            "maxLength":240,
            "type":"string",
            "description":"Name of the position, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationTreeVersionName":{
            "title":"Organization Tree Version Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the organization hierarchy version, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Unique identifier for the business unit, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "PositionTreeName":{
            "title":"Position Hierarchy",
            "maxLength":80,
            "type":"string",
            "description":"Name of the position hierarchy, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TopDepartmentId":{
            "title":"Top Department ID",
            "type":"integer",
            "description":"Unique identifier for the top department in the department hierarchy, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobFamilyId":{
            "title":"Job Family ID",
            "type":"integer",
            "description":"Unique identifier for the job family, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Business Title",
            "maxLength":80,
            "type":"string",
            "description":"Business title of the person assigned to the responsibility.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RecruitingTypeCode":{
            "title":"Recruiting Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the recruiting type, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AssignmentCategory":{
            "title":"Assignment Category Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the assignment category, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "DepartmentName":{
            "title":"Department",
            "maxLength":240,
            "type":"string",
            "description":"Name of the department, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "GradeSetCode":{
            "title":"Grade Set Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the grade set, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "TopOrganizationId":{
            "title":"Top Organization ID",
            "type":"integer",
            "description":"Unique identifier for the top organization in the organization hierarchy, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BargainingUnit":{
            "title":"Bargaining Unit",
            "maxLength":80,
            "type":"string",
            "description":"Name of the bargaining unit, which is used in defining the responsibility scope.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "HierarchyType":{
            "title":"Hierarchy Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the hierarchy type, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PayrollStatUnitId":{
            "title":"Payroll Statutory Unit ID",
            "type":"integer",
            "description":"Unique identifier for the payroll statutory unit, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobFunctionCode":{
            "title":"Job Function Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the job function, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"default"
            },
            "x-queryable":true
        },
        "ResponsibilityTypeMeaning":{
            "title":"Responsibility Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of responsibility, such as human resources representative or union representative.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Person Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the person who is assigned to the responsibility.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the assignment assigned to the area of responsibility.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateName":{
            "title":"Template Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the area of responsibility template.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "GradeId":{
            "title":"Grade ID",
            "type":"integer",
            "description":"Unique identifier for the grade, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Short code of the business unit, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the country, which is used for defining the responsibility scope, such as US.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"Unique identifier of the area of responsibility template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "JobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Unique identifier for the job, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LastNameEnd":{
            "title":"To Last Name",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "BenefitGroupName":{
            "title":"Benefit Group",
            "maxLength":240,
            "type":"string",
            "description":"Name of the benefit group, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "HierarchyLevels":{
            "title":"Hierarchy Levels",
            "type":"integer",
            "description":"Number of levels in the hierarchy, which is used in defining the responsibility scope.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":2
            }
        },
        "BargainingUnitCode":{
            "title":"Bargaining Unit Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the bargaining unit, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RecruitingLocHierarchyName":{
            "title":"Recruiting Location Hierarchy",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the recruiting location hierarchy, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Department ID",
            "type":"integer",
            "description":"Unique identifier for the department, which is used in defining the responsibility scope.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "JobFunctionMeaning":{
            "title":"Job Function",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the job function code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationTreeCode":{
            "title":"Organization Tree Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the organization tree, which is used in defining the responsibility scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Banner Override Messages

Type: array

Title: Banner Override Messages

The bannerOverrideMessages resource provides all the status information and related messages for an object.

Show Source

• Array of: object areasOfResponsibility-bannerOverrideMessages-item-response

{
    "title":"Banner Override Messages",
    "type":"array",
    "description":"The bannerOverrideMessages resource provides all the status information and related messages for an object.",
    "items":{
        "$ref":"#/components/schemas/areasOfResponsibility-bannerOverrideMessages-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 : areasOfResponsibility-bannerOverrideMessages-item-response

Type: object

Show Source

• BusinessProcessName: string
  Maximum Length: 60

  Name of the business process like Areas of Responsibility.
• IdentificationKey: string
  Maximum Length: 255

  Identifier of the task related to the object.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Object: string
  Maximum Length: 100

  Name of the responsibiity table, PER_ASG_RESPONSIBILITIES.
• ObjectId: integer (int64)
  Unique identifier of the responsibility object.
• PrimaryActionLabelForBanner: string
  Maximum Length: 255

  Text for the actionable link to navigate to the approval details page.
• PrimaryTextForBanner: string
  Maximum Length: 255

  Primary text of the approval message.
• RootTaskId: string
  Maximum Length: 255

  Identifier of the root task related to the object.
• SecondaryTextForBanner: string
  Maximum Length: 255

  Secondary text of the approval message.
• Subject: string
  Maximum Length: 100

  Name of the assignments table, PER_ALL_ASSIGNMENTS_M.
• SubjectId: integer (int64)
  Unique identifier of the person's assignment.
• TaskNumber: integer
  Unique identifier of the task related to the object.
• TaskState: string
  Maximum Length: 255

  State of the task such as Assigned, Withdrawn.
• TransactionId: integer
  Identifier of the pending approval transaction.
• TransactionState: string
  Maximum Length: 255

  State of the transaction such as Initial, Saved, or Submitted.
• TransactionStatus: string
  Maximum Length: 255

  Status of the transaction such as Draft, Approved, or Pending.

{
    "type":"object",
    "properties":{
        "TransactionState":{
            "maxLength":255,
            "type":"string",
            "description":"State of the transaction such as Initial, Saved, or Submitted.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Unique identifier of the responsibility object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryTextForBanner":{
            "maxLength":255,
            "type":"string",
            "description":"Primary text of the approval message.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryTextForBanner":{
            "maxLength":255,
            "type":"string",
            "description":"Secondary text of the approval message.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskNumber":{
            "type":"integer",
            "description":"Unique identifier of the task related to the object.",
            "nullable":true,
            "x-queryable":true
        },
        "RootTaskId":{
            "maxLength":255,
            "type":"string",
            "description":"Identifier of the root task related to the object.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the transaction such as Draft, Approved, or Pending.",
            "nullable":true,
            "x-queryable":true
        },
        "IdentificationKey":{
            "maxLength":255,
            "type":"string",
            "description":"Identifier of the task related to the object.",
            "nullable":true,
            "x-queryable":true
        },
        "Subject":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the assignments table, PER_ALL_ASSIGNMENTS_M.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Identifier of the pending approval transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryActionLabelForBanner":{
            "maxLength":255,
            "type":"string",
            "description":"Text for the actionable link to navigate to the approval details page.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Object":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the responsibiity table, PER_ASG_RESPONSIBILITIES.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessProcessName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the business process like Areas of Responsibility.",
            "nullable":true,
            "x-queryable":true
        },
        "SubjectId":{
            "type":"integer",
            "description":"Unique identifier of the person's assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskState":{
            "maxLength":255,
            "type":"string",
            "description":"State of the task such as Assigned, Withdrawn.",
            "nullable":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."
        }
    }
}

Links

AssignmentCategoryLovVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

BargainingUnitLovVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

BenefitGroupsLovVA

Operation: /hcmRestApi/resources/11.13.18.05/benefitGroupsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: BenefitGroupName; Target Attribute: BenefitGroupName
• Display Attribute: BenefitGroupName

BusinessUnitLovVA

Operation: /hcmRestApi/resources/11.13.18.05/hcmBusinessUnitsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: BusinessUnitName; Target Attribute: Name
• Display Attribute: Name

CountryLovVA

Operation: /hcmRestApi/resources/11.13.18.05/hcmCountriesLov

The following properties are defined on the LOV link relation:

• Source Attribute: CountryCode; Target Attribute: TerritoryCode
• Display Attribute: CountryName

DepartmentLovVA

Operation: /hcmRestApi/resources/11.13.18.05/departmentsLov

The following properties are defined on the LOV link relation:

• Source Attribute: DepartmentName; Target Attribute: Name
• Display Attribute: Name

DepartmentTreeLOVVA

Operation: /hcmRestApi/resources/11.13.18.05/hcmTreesLOV

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

GeographyHiringPVOVA

Operation: /hcmRestApi/resources/11.13.18.05/recruitingGeographyHierarchyLocationsLOV

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/hcmSetsLOV

The 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/gradesLov

The following properties are defined on the LOV link relation:

• Source Attribute: GradeCode; Target Attribute: GradeCode
• Display Attribute: Name

HierarchyTypeLovVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

JobFamilyLovVA

Operation: /hcmRestApi/resources/11.13.18.05/jobFamiliesLov

The following properties are defined on the LOV link relation:

• Source Attribute: JobFamilyCode; Target Attribute: JobFamilyCode
• Display Attribute: JobFamilyName

JobFunctionLovVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

JobSetLovVA

Operation: /hcmRestApi/resources/11.13.18.05/hcmSetsLOV

The 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/jobsLov

The following properties are defined on the LOV link relation:

• Source Attribute: JobCode; Target Attribute: JobCode
• Display Attribute: JobName

LegalEmployerLovVA

Operation: /hcmRestApi/resources/11.13.18.05/legalEmployersLov

The following properties are defined on the LOV link relation:

• Source Attribute: LegalEmployerName; Target Attribute: Name
• Display Attribute: Name

LegislativeDataGroupLovVA

Operation: /hcmRestApi/resources/11.13.18.05/legislativeDataGroupsLOV

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/hcmSetsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: LocationSetCode; Target Attribute: SetCode
• Display Attribute: SetName

LocationVA

Operation: /hcmRestApi/resources/11.13.18.05/locationsLov

The following properties are defined on the LOV link relation:

• Source Attribute: LocationCode; Target Attribute: LocationCode
• Display Attribute: LocationName

OrganizationHiringPVOVA

Operation: /hcmRestApi/resources/11.13.18.05/recruitingOrganizationsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: RecruitingOrgHierarchyName; Target Attribute: Name
• Display Attribute: Name

OrganizationTreeLOVVA

Operation: /hcmRestApi/resources/11.13.18.05/hcmTreesLOV

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

PayrollStatuatoryUnitVA

Operation: /hcmRestApi/resources/11.13.18.05/payrollStatutoryUnitsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: PayrollStatutoryUnitName; Target Attribute: PayrollStatutoryUnitName
• Display Attribute: PayrollStatutoryUnitName

PayrollVA

Operation: /hcmRestApi/resources/11.13.18.05/payrollDefinitionsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: PayrollName; Target Attribute: PayrollName
• Display Attribute: PayrollName

PositionLovVA

Operation: /hcmRestApi/resources/11.13.18.05/positionsLov

The following properties are defined on the LOV link relation:

• Source Attribute: PositionCode; Target Attribute: PositionCode
• Display Attribute: PositionName

PositionTreeLOVVA

Operation: /hcmRestApi/resources/11.13.18.05/hcmTreesLOV

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

RecruitingTypeLovVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ResponsibilityStatusVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

ResponsibilityTemplatesLovVA

Operation: /hcmRestApi/resources/11.13.18.05/responsibilityTemplatesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: TemplateCode; Target Attribute: Code
• Display Attribute: Name

ResponsibilityTypeLovVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

TaxReportingUnitVA

Operation: /hcmRestApi/resources/11.13.18.05/taxReportingUnitsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: TaxReportingUnitName; Target Attribute: TaxReportingUnitName
• Display Attribute: TaxReportingUnitName

TopDepartmentTreeLOVVA

Operation: /hcmRestApi/resources/11.13.18.05/departmentTreeNodesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: TopDepartmentName; Target Attribute: DepartmentName
• Display Attribute: DepartmentName

TopOrganizationTreeLOVVA

Operation: /hcmRestApi/resources/11.13.18.05/organizationTreeNodesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: TopOrganizationName; Target Attribute: OrganizationName
• Display Attribute: OrganizationName

TopPositionTreeLOVVA

Operation: /hcmRestApi/resources/11.13.18.05/positionTreeNodesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: TopPositionName; Target Attribute: PositionName
• Display Attribute: PositionName

bannerOverrideMessages

Operation: /hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}/child/bannerOverrideMessages

Parameters:

• areasOfResponsibilityUniqID: $request.path.areasOfResponsibilityUniqID

The bannerOverrideMessages resource provides all the status information and related messages for an object.

reassign

Operation: /hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}/action/reassign

Parameters:

• areasOfResponsibilityUniqID: $request.path.areasOfResponsibilityUniqID

Reassigns an area of responsibility to a different worker.

Back to Top