Jump to

• Request
• Response

Get all included workers along with their hierarchy

get

/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devIncludedWorkers

Request

Path Parameters

• devGoalsMassAssignProcessUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Development Goals Mass Assignment Process resource and used to uniquely identify an instance of Development Goals Mass Assignment Process. The client should not generate the hash key value. Instead, the client should query on the Development Goals Mass Assignment Process collection resource in order to navigate to a specific instance of Development Goals Mass Assignment Process 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds a worker included in the mass assignment process of development goals who matches the primary key criteria specified.
    Finder Variables
    • MassRequestHierarchyId; integer; Unique identifier for the mass request hierarchy.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssignmentId; integer; Unique identifier for the assignment of the worker included in the mass assignment process of development goals.
  • AssignmentName; string; Name of the assignment of the worker included in the mass assignment process of development goals.
  • AssignmentNumber; string; Assignment number of the worker included in the mass assignment process of development goals.
  • AssignmentStatusType; string; Assignment status type of the worker included in the mass assignment process of development goals.
  • BusinessTitle; string; Business title of the worker included in the mass assignment process of development goals.
  • CascadingLevel; integer; A code that determines which employees reporting to the requester will be assigned the development goals during the mass assignment process. The development goals can be assigned only to the requester, all direct reports of the requester, all direct reports of the requester and the requester, all reports of the requester, and all reports of the requesters and the requester.
  • CreatedBy; string; User who added the worker to the mass assignment process of development goals.
  • CreationDate; string; Date the worker was included in the mass assignment process of development goals.
  • DepartmentName; string; Name of the department that the worker included in the mass assignment process of development goals belongs to.
  • DirectsCount; integer; Count of persons who report directly to the manager included in the mass assignment process of development goals.
  • DisplayName; string; Display name of the worker included in the mass assignment process of development goals.
  • LastUpdateDate; string; Date the details of the worker included in the mass assignment process of development goals was last updated.
  • LastUpdatedBy; string; User who last updated the details of the worker included in the mass assignment process of development goals.
  • ManagerName; string; Name of the manager of the worker included in the mass assignment process of development goals.
  • MassRequestHierarchyId; integer; Unique identifier for the mass request hierarchy.
  • PersonId; integer; Unique identifier of the worker included in the mass assignment process of development goals.
  • PersonNumber; string; Person number of the worker included in the mass assignment process of development goals.
  • PositionName; string; Name of the position of the worker included in the mass assignment process of development goals.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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(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 : devGoalsMassAssignProcess-devIncludedWorkers

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/devGoalsMassAssignProcess-devIncludedWorkers-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object devGoalsMassAssignProcess-devIncludedWorkers-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/devGoalsMassAssignProcess-devIncludedWorkers-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 : devGoalsMassAssignProcess-devIncludedWorkers-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  Title: Manager Assignment

  Unique identifier for the assignment of the worker included in the mass assignment process of development goals.
• AssignmentName: string
  Title: Assignment Name

  Read Only: true

  Maximum Length: 80

  Name of the assignment of the worker included in the mass assignment process of development goals.
• AssignmentNumber: string
  Title: Assignment Number

  Read Only: true

  Maximum Length: 30

  Assignment number of the worker included in the mass assignment process of development goals.
• AssignmentStatusType: string
  Title: Assignment Status

  Read Only: true

  Maximum Length: 30

  Assignment status type of the worker included in the mass assignment process of development goals.
• BusinessTitle: string
  Title: Job

  Read Only: true

  Maximum Length: 255

  Business title of the worker included in the mass assignment process of development goals.
• CascadingLevel: integer (int64)
  Title: Assignees

  A code that determines which employees reporting to the requester will be assigned the development goals during the mass assignment process. The development goals can be assigned only to the requester, all direct reports of the requester, all direct reports of the requester and the requester, all reports of the requester, and all reports of the requesters and the requester.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who added the worker to the mass assignment process of development goals.
• CreationDate: string (date-time)
  Read Only: true

  Date the worker was included in the mass assignment process of development goals.
• DepartmentName: string
  Title: Department

  Read Only: true

  Maximum Length: 255

  Name of the department that the worker included in the mass assignment process of development goals belongs to.
• DirectsCount: integer
  Read Only: true

  Count of persons who report directly to the manager included in the mass assignment process of development goals.
• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the worker included in the mass assignment process of development goals.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the details of the worker included in the mass assignment process of development goals was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the details of the worker included in the mass assignment process of development goals.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManagerName: string
  Title: Manager Name

  Read Only: true

  Maximum Length: 255

  Name of the manager of the worker included in the mass assignment process of development goals.
• MassRequestHierarchyId: integer (int64)
  Title: Mass Request Hierarchy ID

  Unique identifier for the mass request hierarchy.
• PersonId: integer (int64)
  Title: Person

  Unique identifier of the worker included in the mass assignment process of development goals.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Person number of the worker included in the mass assignment process of development goals.
• PositionName: string
  Title: Position

  Read Only: true

  Maximum Length: 255

  Name of the position of the worker included in the mass assignment process of development goals.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the details of the worker included in the mass assignment process of development goals.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the worker included in the mass assignment process of development goals.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the worker was included in the mass assignment process of development goals.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who added the worker to the mass assignment process of development goals.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PositionName":{
            "title":"Position",
            "maxLength":255,
            "type":"string",
            "description":"Name of the position of the worker included in the mass assignment process of development goals.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MassRequestHierarchyId":{
            "title":"Mass Request Hierarchy ID",
            "type":"integer",
            "description":"Unique identifier for the mass request hierarchy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ManagerName":{
            "title":"Manager Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the manager of the worker included in the mass assignment process of development goals.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssignmentStatusType":{
            "title":"Assignment Status",
            "maxLength":30,
            "type":"string",
            "description":"Assignment status type of the worker included in the mass assignment process of development goals.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person",
            "type":"integer",
            "description":"Unique identifier of the worker included in the mass assignment process of development goals.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Assignment Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the assignment of the worker included in the mass assignment process of development goals.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BusinessTitle":{
            "title":"Job",
            "maxLength":255,
            "type":"string",
            "description":"Business title of the worker included in the mass assignment process of development goals.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the worker included in the mass assignment process of development goals.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Assignment number of the worker included in the mass assignment process of development goals.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Manager Assignment",
            "type":"integer",
            "description":"Unique identifier for the assignment of the worker included in the mass assignment process of development goals.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "DepartmentName":{
            "title":"Department",
            "maxLength":255,
            "type":"string",
            "description":"Name of the department that the worker included in the mass assignment process of development goals belongs to.",
            "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"
            }
        },
        "CascadingLevel":{
            "title":"Assignees",
            "type":"integer",
            "description":"A code that determines which employees reporting to the requester will be assigned the development goals during the mass assignment process. The development goals can be assigned only to the requester, all direct reports of the requester, all direct reports of the requester and the requester, all reports of the requester, and all reports of the requesters and the requester.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the details of the worker included in the mass assignment process of development goals was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DirectsCount":{
            "type":"integer",
            "description":"Count of persons who report directly to the manager included in the mass assignment process of development goals.",
            "nullable":true,
            "readOnly":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