Jump to

• Request
• Response

Get a direct report

get

/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/directReports/{directReportsUniqID}

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=
• 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=
• directReportsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AssignmentId and RelationshipType ---for the Direct Reports resource and used to uniquely identify an instance of Direct Reports. The client should not generate the hash key value. Instead, the client should query on the Direct Reports collection resource with a filter on the primary key values in order to navigate to a specific instance of Direct Reports.
  
  For example: directReports?q=AssignmentId=<value1>;RelationshipType=<value2>

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 Top

Response

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.

Body ()

Root Schema : publicWorkers-assignments-directReports-item-response

Type: object

Show Source

• AllReportsCount: number
  Title: Total Workers

  Read Only: true

  Count of all reports of the worker.
• AssignmentId: integer (int64)
  Title: Assignment ID

  Read Only: true

  Internal identifier for the report's assignment.
• AssignmentName: string
  Title: Business Title

  Read Only: true

  Maximum Length: 80

  Business title of the report.
• AssignmentNumber: string
  Title: Assignment Number

  Read Only: true

  Maximum Length: 50

  Assignment number of the report.
• DirectReportsCount: number
  Title: Total Directs

  Read Only: true

  Count of direct reports of the worker.
• DisplayName: string
  Title: Display Name

  Read Only: true

  Maximum Length: 240

  Display name of the report.
• FirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  Person's first name.
• 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.
• PersonId: integer (int64)
  Title: Person ID

  Read Only: true

  Internal identifier for the report.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Person number of the report.
• Photo: string (byte)
  Title: Photo

  Unique location of the image. Encrypted version of the file.
• PhotoId: integer (int64)
  Title: Photo ID

  Surrogate identifier for the photo.
• PhotoName: string
  Title: Photo Name

  Maximum Length: 240

  Name of the image file.
• RelationshipType: string
  Title: Relationship Type

  Read Only: true

  Maximum Length: 30

  Type of managerial relationship with the report, such as line manager.
• RelationshipTypeMeaning: string
  Title: Relationship Type

  Read Only: true

  Maximum Length: 80

  Name of managerial relationship with the report such as line manager.
• WorkerType: string
  Title: Worker Type

  Read Only: true

  Maximum Length: 30

  Worker type for the period of service such as Employee (E), Contingent Worker (C), Pending Worker (P), or Nonworker (N).

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Person number of the report.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipTypeMeaning":{
            "title":"Relationship Type",
            "maxLength":"80",
            "type":"string",
            "description":"Name of managerial relationship with the report such as line manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"Person's first name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DirectReportsCount":{
            "title":"Total Directs",
            "type":"number",
            "description":"Count of direct reports of the worker.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllReportsCount":{
            "title":"Total Workers",
            "type":"number",
            "description":"Count of all reports of the worker.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of managerial relationship with the report, such as line manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "KnownAs":{
            "title":"Known As",
            "maxLength":"80",
            "type":"string",
            "description":"Person's preferred name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Photo":{
            "title":"Photo",
            "type":"string",
            "description":"Unique location of the image. Encrypted version of the file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PhotoId":{
            "title":"Photo ID",
            "type":"integer",
            "description":"Surrogate identifier for the photo.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkerType":{
            "title":"Worker Type",
            "maxLength":"30",
            "type":"string",
            "description":"Worker type for the period of service such as Employee (E), Contingent Worker (C), Pending Worker (P), or Nonworker (N).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Internal identifier for the report.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Business Title",
            "maxLength":"80",
            "type":"string",
            "description":"Business title of the report.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Internal identifier for the report's assignment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":"50",
            "type":"string",
            "description":"Assignment number of the report.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":"240",
            "type":"string",
            "description":"Display name of the report.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"Person's last name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhotoName":{
            "title":"Photo Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the image file.",
            "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."
        }
    }
}

Back to Top