Get a worker manager
get
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/managers/{AssignmentSupervisorId}
Request
Path Parameters
-
AssignmentId(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=
-
AssignmentSupervisorId(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=
-
PersonId(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 : publicWorkers-assignments-managers-item-response
Type:
Show Source
object
-
AssignmentSupervisorId: integer
(int64)
Title:
Assignment Supervisor ID
Surrogate identifier for the supervisor on workers assignment. -
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
Person's display name. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
Person's first name. -
JobCode: string
Title:
Code
Read Only:true
Maximum Length:30
Code of the job for the manager assignment. -
JobName: string
Title:
Job
Read Only:true
Maximum Length:240
Name of the job for the manager assignment. -
KnownAs: string
Title:
Known As
Read Only:true
Maximum Length:80
Person's preferred name. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
Person's last name. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerAssignmentId: integer
(int64)
Title:
Manager Assignment ID
Surrogate identifier for the assignment supervisor. -
ManagerAssignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Assignment name of the supervisor. -
ManagerAssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Assignment number of the supervisor. -
ManagerPersonId: integer
(int64)
Title:
Manager ID
Surrogate identifier for the supervisor. -
ManagerPersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person Number of the supervisor. -
ManagerType: string
Title:
Manager Type
Maximum Length:30
Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on. -
ManagerTypeMeaning: string
Title:
Manager Type
Read Only:true
Maximum Length:80
Name of the role the supervisor has with regards to the overall organization structure, such as functional, project leader, and so on. -
Photo: string
(byte)
Title:
Image
Unique location of the image. Encrypted version of the file. -
PhotoId: integer
(int64)
Title:
Photo ID
Surrogate identifier for the supervisor photo. -
PhotoName: string
Title:
Photo Name
Maximum Length:240
Name of the image file of the supervisor. -
PositionCode: string
Title:
Code
Read Only:true
Maximum Length:30
Code of the position for the manager assignment. -
PositionName: string
Title:
Position
Read Only:true
Maximum Length:240
Name of the position for the manager assignment. -
WorkEmail: string
Title:
Work Email
Read Only:true
Maximum Length:240
Manager's work e-mail address.
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.