Get a single scope attribute for a specified responsibility template
get
/hcmRestApi/resources/11.13.18.05/areasOfResponsibilityTemplates/{TemplateId}/child/AoRTemplateScope/{TemplateDetailsId}
Request
Path Parameters
-
TemplateDetailsId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
TemplateId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : areasOfResponsibilityTemplates-AoRTemplateScope-item-response
Type:
Show Source
object
-
AttributeName: string
Title:
Attribute Name
Maximum Length:30
Name of the scope attribute. Attribute names must be unique and can't be duplicated. Valid values are: AOR_LEGAL_EMPLOYER, AOR_BUSINESS_UNIT, AOR_DEPARTMENT, AOR_LOCATION, AOR_JOB, AOR_POSITION, AOR_ASSIGNMENT_CATEGORY, AOR_BENEIFIT_GROUP, AOR_BARG_UNIT, AOR_COUNTRY, AOR_GRADE, AOR_JOB_FAMILY, AOR_JOB_FUNCTION, AOR_PAYROLL, AOR_PAYROLL_STATUTORY_UNIT, AOR_TAX_RPTG_UNIT, AOR_LEGISLATIVE_DATA_GRP, AOR_RECRUIT_TYPE, AOR_RECRUIT_LOC_HIER, AOR_RECRUIT_ORG_HIER, AOR_HIERARCHY_TYPE, or AOR_LAST_NAME_FROM. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the responsibility template scope. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the responsibility template scope was created. -
DefaultValue: string
Title:
Value
Maximum Length:1000
Related attribute codes when AttributeName relates to: AOR_ASSIGNMENT_CATEGORY, AOR_JOB_FUNCTION, AOR_RECRUIT_TYPE, AOR_HIERARCHY_TYPE, or AOR_LAST_NAME_FROM. For AOR_HIERARCHY_TYPE, specify one of: AOR_ORG, AOR_POS, AOR_DEPT, or AOR_SUPV. For AOR_LAST_NAME_FROM, provide the specific text for the starting range text of the last name. -
DefaultValue2: string
Maximum Length:
1000
Related attribute codes when AttributeName relates to either AOR_BARG_UNIT or AOR_COUNTRY. If you provided DefaultValue of AOR_ORG, AOR_POS, or AOR_DEPT, provide the associated hierarchy tree ID. -
DefaultValue3: string
Maximum Length:
1000
Related attribute codes when AttributeName relates to any of these: Last Name End, Recruiting Org Tree. If you provided DefaultValue of AOR_LAST_NAME_FROM, provide the specific text for the ending range text of the last name. If you provided DefaultValue of AOR_ORG, AOR_POS, or AOR_DEPT, provide the associated hierarchy tree code. -
DefaultValue4: string
Maximum Length:
1000
Recruiting Org Tree Version attribute code when AttributeName is AOR_RECRUIT_ORG_HIER. -
DefaultValue5: string
Maximum Length:
1000
Number of hierarchy levels if you provided AttributeName of AOR_HIERARCHY_TYPE. -
DefaultValue6: string
Maximum Length:
1000
Value for Include Top Hierarchy Node if you provided AttributeName of AOR_HIERARCHY_TYPE. Valid values are Y or N. The default value is N. -
DefaultValueNameChoice: string
Maximum Length:
255
List of value switcher for values to be stored in DefaultValue2, DefaultValue3, DefaultValue5 and DefaultValue6 attributes. -
DefaultValueNumber: integer
(int64)
Related attribute ID when AttributeName is any of these: AOR_LEGAL_EMPLOYER, AOR_BUSINESS_UNIT, AOR_DEPARTMENT, AOR_LOCATION, AOR_JOB, AOR_POSITION, AOR_GRADE, AOR_JOB_FAMILY, AOR_PAYROLL_STATUTORY_UNIT, AOR_TAX_RPTG_UNIT, AOR_LEGISLATIVE_DATA_GRP, AOR_RECRUIT_LOC_HIER or AOR_RECRUIT_ORG_HIER. If you provided DefaultValue of AOR_ORG, AOR_POS, or AOR_DEPT, provide the top node code of the associated hierarchy tree. If you provided DefaultValue of AOR_SUPV, provide the top supervisor's person ID.
-
DisplaySequence: integer
(int32)
Title:
Display Order
Unique sequence number representing the display order of the scope attribute. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the responsibility template scope was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the responsibility template scope. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RequiredFlag: boolean
Title:
Required
Maximum Length:30
Default Value:false
Indicator of whether the AttributeName is required. Populate this field only if DefaultValue is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N. -
RequiredFlag2: string
Maximum Length:
30
Default Value:N
Indicator of whether the AttributeName is required. Populate this field only if DefaultValue2 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N. -
RequiredFlag3: string
Maximum Length:
30
Default Value:N
Indicator of whether the AttributeName is required. Populate this field only if DefaultValue3 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N. -
RequiredFlag4: string
Maximum Length:
30
Default Value:N
Indicator of whether the AttributeName is required. Populate this field only if DefaultValue4 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N. -
RequiredFlag5: string
Maximum Length:
30
Default Value:N
Indicator of whether the AttributeName is required. Populate this field only if DefaultValue5 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N. -
RequiredFlag6: string
Maximum Length:
30
Default Value:N
Indicator of whether the AttributeName is required. Populate this field only if DefaultValue6 is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N. -
RequiredFlagNumber: string
Maximum Length:
30
Default Value:N
Indicator of whether the AttributeName is required. Populate this field only if DefaultValueNumber is present. Leave all other Required Flag values blank. Valid values are Y and N. The default value is N. -
TemplateDetailsId: integer
(int64)
Surrogate identifier for a scope attribute of a template.
-
TemplateId: integer
(int64)
Template identifier for the responsibility template scope.
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
- AttributeNameLovVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{AttributeName}%2CLookupType%3DORA_PER_AOR_TEMPLATE_ATTRIBUTE
The following properties are defined on the LOV link relation:- Source Attribute: AttributeName; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: