Jump to

• Request
• Response
• Examples

Get a worker assignment

get

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

Request

Path Parameters

• AssignmentId(required): integer(int64)
  Internal identifier for the assignment.
• PersonId(required): integer(int64)
  Internal identifier for the person.

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(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 : publicWorkers-assignments-item-response

Type: object

Show Source

• allReports: array All Reports
  Title: All Reports

  The allReports resource is a child of the assignments resource. It includes all the reports of a worker as of the current date for a specific assignment.
• allReportsDepartments: array AllReportsDepartments
  Title: AllReportsDepartments

  The allReportsDepartments resource is a child of the assignments resource. It includes all the distinct departments that all the reports of a worker belong to, as of the system date for a specific assignment.
• allReportsLocations: array AllReportsLocations
  Title: AllReportsLocations

  The allReportsLocations resource is a child of the assignments resource. It includes all the distinct locations that all the reports of a worker belong to, as of the system date for a specific assignment.
• AssignmentId: integer (int64)
  Title: Assignment ID

  Read Only: true

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

  Read Only: true

  Maximum Length: 80

  Name of the worker assignment.
• AssignmentNumber: string
  Title: Assignment Number

  Read Only: true

  Maximum Length: 30

  Unique identifier for the worker assignment.
• BusinessUnitName: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  Name of the business unit for the worker assignment.
• DepartmentName: string
  Title: Department

  Read Only: true

  Maximum Length: 240

  Name of the department for the worker assignment.
• directReports: array DirectReports
  Title: DirectReports

  The directReports resource is a child of the assignments resource. It includes all the direct reports of a worker as of the system date for a specific assignment.
• employmentHistory: array Employment History
  Title: Employment History

  The employmentHistory resource is a child of the assignments resource. It includes the employment history of a worker.
• FullPartTime: string
  Title: Full Time or Part Time

  Read Only: true

  Maximum Length: 30

  Indicates whether the worker is working full time or part time.
• GradeCode: string
  Title: Grade Code

  Read Only: true

  Maximum Length: 30

  Code of the grade for the worker assignment.
• GradeName: string
  Title: Grade

  Read Only: true

  Maximum Length: 240

  Name of the grade for the worker assignment.
• InternalBuilding: string
  Title: Building

  Read Only: true

  Maximum Length: 45

  Building information associated with the work location.
• InternalFloor: string
  Title: Floor

  Read Only: true

  Maximum Length: 45

  Floor information associated with the work location.
• InternalMailstop: string
  Title: Mail Stop

  Read Only: true

  Maximum Length: 45

  Internal mail location.
• InternalOfficeNumber: string
  Title: Office Number

  Read Only: true

  Maximum Length: 45

  Office number associated with the work location.
• JobCode: string
  Title: Job Code

  Read Only: true

  Maximum Length: 30

  Code of the job for the worker assignment.
• JobName: string
  Title: Job

  Read Only: true

  Maximum Length: 240

  Name of the job for the worker assignment.
• LegalEmployerName: string
  Title: Legal Employer

  Read Only: true

  Maximum Length: 240

  Name of the legal employer for the assignment.
• LengthOfServiceDays: integer
  Length of service of a worker in additional days that are less than a full month.
• LengthOfServiceMonths: integer
  Length of service of a worker in additional months that are less than a full year.
• LengthOfServiceYears: integer
  Length of service of a worker in years.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationAddressLine1: string
  Title: Address Line 1

  Read Only: true

  Maximum Length: 240

  First line of the work location address.
• LocationAddressLine2: string
  Title: Address Line 2

  Read Only: true

  Maximum Length: 240

  Second line of the work location address.
• LocationAddressLine3: string
  Title: Address Line 3

  Read Only: true

  Maximum Length: 240

  Third line of the work location address.
• LocationAddressLine4: string
  Title: Address Line 4

  Read Only: true

  Maximum Length: 240

  Fourth line of the work location address.
• LocationCode: string
  Title: Location Code

  Read Only: true

  Maximum Length: 60

  Code of the location for the worker assignment.
• LocationCountry: string
  Title: Country

  Read Only: true

  Maximum Length: 60

  Country in which the work address is located.
• LocationLongPostalCode: string
  Title: Long Postal Code

  Read Only: true

  Maximum Length: 30

  Long postal code of the work location.
• LocationMultiLineAddress: string
  Title: Address

  Read Only: true

  Multi line address.
• LocationName: string
  Title: Location

  Read Only: true

  Maximum Length: 240

  Name of the location for the worker assignment.
• LocationPostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 30

  Postal code of the work location.
• LocationRegion1: string
  Title: Region 1

  Read Only: true

  Maximum Length: 120

  Primary region in which the work address is located.
• LocationRegion2: string
  Title: Region 2

  Read Only: true

  Maximum Length: 120

  Secondary region within the primary region.
• LocationRegion3: string
  Title: Region 3

  Read Only: true

  Maximum Length: 120

  Sub-region within the secondary region.
• LocationSingleLineAddress: string
  Title: Address

  Read Only: true

  Single line address.
• LocationTimezoneCode: string
  Title: Time Zone Code

  Read Only: true

  Maximum Length: 50

  Time zone of the work location.
• LocationTownOrCity: string
  Title: Town or City

  Read Only: true

  Maximum Length: 30

  Town or city in which the work address is located.
• ManagerName: string
  Title: Manager

  Read Only: true

  Maximum Length: 240

  Name of the manager.
• managers: array Managers
  Title: Managers

  The managers resource is a child of the assignments resource. It includes all the managers of a worker.
• MarkedAsFavoriteFlag: boolean
  Read Only: true

  Maximum Length: 30

  Indicates whether the current person is marked as favorite for a particular user. Valid values are Yes and No.
• PositionCode: string
  Title: Position Code

  Read Only: true

  Maximum Length: 30

  Code of the position for the worker assignment.
• PositionName: string
  Title: Position

  Read Only: true

  Maximum Length: 240

  Name of the position for the worker assignment.
• PrimaryAssignmentFlag: boolean
  Title: Primary Assignment

  Read Only: true

  Maximum Length: 30

  Indicates whether the current assignment is primary for the work relationship. Valid values are Yes and No.
• PrimaryFlag: boolean
  Title: Primary

  Read Only: true

  Maximum Length: 30

  Indicates whether the current assignment is the primary assignment for the worker. Valid values are Yes and No.
• representatives: array Representatives
  Title: Representatives

  The representatives resource is a child of the assignments resource. It includes all the worker representatives as of the current date.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  Start date of the period of employment.
• WorkAtHomeFlag: boolean
  Title: Working at Home

  Read Only: true

  Maximum Length: 30

  Indicates whether the person is working at home. Valid values are Yes and No.
• WorkerNumber: string
  Title: Worker Number

  Read Only: true

  Maximum Length: 30

  Unique identifier for a worker.
• 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 Non-worker (N).

{
    "type":"object",
    "properties":{
        "LocationLongPostalCode":{
            "title":"Long Postal Code",
            "maxLength":30,
            "type":"string",
            "description":"Long postal code of the work location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerName":{
            "title":"Manager",
            "maxLength":240,
            "type":"string",
            "description":"Name of the manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalBuilding":{
            "title":"Building",
            "maxLength":45,
            "type":"string",
            "description":"Building information associated with the work location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FullPartTime":{
            "title":"Full Time or Part Time",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the worker is working full time or part time.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the period of employment.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LengthOfServiceDays":{
            "type":"integer",
            "description":"Length of service of a worker in additional days that are less than a full month.",
            "nullable":true,
            "x-queryable":false
        },
        "LegalEmployerName":{
            "title":"Legal Employer",
            "maxLength":240,
            "type":"string",
            "description":"Name of the legal employer for the assignment.",
            "nullable":false,
            "readOnly":true,
            "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 Non-worker (N).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GradeCode":{
            "title":"Grade Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the grade for the worker assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "allReportsLocations":{
            "title":"AllReportsLocations",
            "type":"array",
            "description":"The allReportsLocations resource is a child of the assignments resource. It includes all the distinct locations that all the reports of a worker belong to, as of the system date for a specific assignment.",
            "items":{
                "$ref":"#/components/schemas/publicWorkers-assignments-allReportsLocations-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LocationAddressLine4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the work location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PositionCode":{
            "title":"Position Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the position for the worker assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationAddressLine3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"Third line of the work location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationAddressLine2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"Second line of the work location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationAddressLine1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"First line of the work location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PositionName":{
            "title":"Position",
            "maxLength":240,
            "type":"string",
            "description":"Name of the position for the worker assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationCode":{
            "title":"Location Code",
            "maxLength":60,
            "type":"string",
            "description":"Code of the location for the worker assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAtHomeFlag":{
            "title":"Working at Home",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the person is working at home. Valid values are Yes and No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LengthOfServiceYears":{
            "type":"integer",
            "description":"Length of service of a worker in years.",
            "nullable":true,
            "x-queryable":false
        },
        "employmentHistory":{
            "title":"Employment History",
            "type":"array",
            "description":"The employmentHistory resource is a child of the assignments resource. It includes the employment history of a worker.",
            "items":{
                "$ref":"#/components/schemas/publicWorkers-assignments-employmentHistory-item-response"
            }
        },
        "LocationPostalCode":{
            "title":"Postal Code",
            "maxLength":30,
            "type":"string",
            "description":"Postal code of the work location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalFloor":{
            "title":"Floor",
            "maxLength":45,
            "type":"string",
            "description":"Floor information associated with the work location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "GradeName":{
            "title":"Grade",
            "maxLength":240,
            "type":"string",
            "description":"Name of the grade for the worker assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Business Title",
            "maxLength":80,
            "type":"string",
            "description":"Name of the worker assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentName":{
            "title":"Department",
            "maxLength":240,
            "type":"string",
            "description":"Name of the department for the worker assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "managers":{
            "title":"Managers",
            "type":"array",
            "description":"The managers resource is a child of the assignments resource. It includes all the managers of a worker.",
            "items":{
                "$ref":"#/components/schemas/publicWorkers-assignments-managers-item-response"
            }
        },
        "allReportsDepartments":{
            "title":"AllReportsDepartments",
            "type":"array",
            "description":"The allReportsDepartments resource is a child of the assignments resource. It includes all the distinct departments that all the reports of a worker belong to, as of the system date for a specific assignment.",
            "items":{
                "$ref":"#/components/schemas/publicWorkers-assignments-allReportsDepartments-item-response"
            }
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the current assignment is the primary assignment for the worker. Valid values are Yes and No.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationRegion1":{
            "title":"Region 1",
            "maxLength":120,
            "type":"string",
            "description":"Primary region in which the work address is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "directReports":{
            "title":"DirectReports",
            "type":"array",
            "description":"The directReports resource is a child of the assignments resource. It includes all the direct reports of a worker as of the system date for a specific assignment.",
            "items":{
                "$ref":"#/components/schemas/publicWorkers-assignments-directReports-item-response"
            }
        },
        "LocationRegion2":{
            "title":"Region 2",
            "maxLength":120,
            "type":"string",
            "description":"Secondary region within the primary region.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationRegion3":{
            "title":"Region 3",
            "maxLength":120,
            "type":"string",
            "description":"Sub-region within the secondary region.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationCountry":{
            "title":"Country",
            "maxLength":60,
            "type":"string",
            "description":"Country in which the work address is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobName":{
            "title":"Job",
            "maxLength":240,
            "type":"string",
            "description":"Name of the job for the worker assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationTownOrCity":{
            "title":"Town or City",
            "maxLength":30,
            "type":"string",
            "description":"Town or city in which the work address is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationName":{
            "title":"Location",
            "maxLength":240,
            "type":"string",
            "description":"Name of the location for the worker assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryAssignmentFlag":{
            "title":"Primary Assignment",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the current assignment is primary for the work relationship. Valid values are Yes and No.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobCode":{
            "title":"Job Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the job for the worker assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalOfficeNumber":{
            "title":"Office Number",
            "maxLength":45,
            "type":"string",
            "description":"Office number associated with the work location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Internal identifier for the assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the worker assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalMailstop":{
            "title":"Mail Stop",
            "maxLength":45,
            "type":"string",
            "description":"Internal mail location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LocationSingleLineAddress":{
            "title":"Address",
            "type":"string",
            "description":"Single line address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit for the worker assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationTimezoneCode":{
            "title":"Time Zone Code",
            "maxLength":50,
            "type":"string",
            "description":"Time zone of the work location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MarkedAsFavoriteFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the current person is marked as favorite for a particular user. Valid values are Yes and No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LengthOfServiceMonths":{
            "type":"integer",
            "description":"Length of service of a worker in additional months that are less than a full year.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkerNumber":{
            "title":"Worker Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for  a worker.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "allReports":{
            "title":"All Reports",
            "type":"array",
            "description":"The allReports resource is a child of the assignments resource. It includes  all the reports of a worker as of the current date for a specific assignment.",
            "items":{
                "$ref":"#/components/schemas/publicWorkers-assignments-allReports-item-response"
            }
        },
        "LocationMultiLineAddress":{
            "title":"Address",
            "type":"string",
            "description":"Multi line address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "representatives":{
            "title":"Representatives",
            "type":"array",
            "description":"The representatives resource is a child of the assignments resource. It includes all the worker representatives as of the current date.",
            "items":{
                "$ref":"#/components/schemas/publicWorkers-assignments-representatives-item-response"
            }
        }
    }
}

Nested Schema : All Reports

Type: array

Title: All Reports

The allReports resource is a child of the assignments resource. It includes all the reports of a worker as of the current date for a specific assignment.

Show Source

• Array of: object publicWorkers-assignments-allReports-item-response

{
    "title":"All Reports",
    "type":"array",
    "description":"The allReports resource is a child of the assignments resource. It includes  all the reports of a worker as of the current date for a specific assignment.",
    "items":{
        "$ref":"#/components/schemas/publicWorkers-assignments-allReports-item-response"
    }
}

Nested Schema : AllReportsDepartments

Type: array

Title: AllReportsDepartments

The allReportsDepartments resource is a child of the assignments resource. It includes all the distinct departments that all the reports of a worker belong to, as of the system date for a specific assignment.

Show Source

• Array of: object publicWorkers-assignments-allReportsDepartments-item-response

{
    "title":"AllReportsDepartments",
    "type":"array",
    "description":"The allReportsDepartments resource is a child of the assignments resource. It includes all the distinct departments that all the reports of a worker belong to, as of the system date for a specific assignment.",
    "items":{
        "$ref":"#/components/schemas/publicWorkers-assignments-allReportsDepartments-item-response"
    }
}

Nested Schema : AllReportsLocations

Type: array

Title: AllReportsLocations

The allReportsLocations resource is a child of the assignments resource. It includes all the distinct locations that all the reports of a worker belong to, as of the system date for a specific assignment.

Show Source

• Array of: object publicWorkers-assignments-allReportsLocations-item-response

{
    "title":"AllReportsLocations",
    "type":"array",
    "description":"The allReportsLocations resource is a child of the assignments resource. It includes all the distinct locations that all the reports of a worker belong to, as of the system date for a specific assignment.",
    "items":{
        "$ref":"#/components/schemas/publicWorkers-assignments-allReportsLocations-item-response"
    }
}

Nested Schema : DirectReports

Type: array

Title: DirectReports

The directReports resource is a child of the assignments resource. It includes all the direct reports of a worker as of the system date for a specific assignment.

Show Source

• Array of: object publicWorkers-assignments-directReports-item-response

{
    "title":"DirectReports",
    "type":"array",
    "description":"The directReports resource is a child of the assignments resource. It includes all the direct reports of a worker as of the system date for a specific assignment.",
    "items":{
        "$ref":"#/components/schemas/publicWorkers-assignments-directReports-item-response"
    }
}

Nested Schema : Employment History

Type: array

Title: Employment History

The employmentHistory resource is a child of the assignments resource. It includes the employment history of a worker.

Show Source

• Array of: object publicWorkers-assignments-employmentHistory-item-response

{
    "title":"Employment History",
    "type":"array",
    "description":"The employmentHistory resource is a child of the assignments resource. It includes the employment history of a worker.",
    "items":{
        "$ref":"#/components/schemas/publicWorkers-assignments-employmentHistory-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 : Managers

Type: array

Title: Managers

The managers resource is a child of the assignments resource. It includes all the managers of a worker.

Show Source

• Array of: object publicWorkers-assignments-managers-item-response

{
    "title":"Managers",
    "type":"array",
    "description":"The managers resource is a child of the assignments resource. It includes all the managers of a worker.",
    "items":{
        "$ref":"#/components/schemas/publicWorkers-assignments-managers-item-response"
    }
}

Nested Schema : Representatives

Type: array

Title: Representatives

The representatives resource is a child of the assignments resource. It includes all the worker representatives as of the current date.

Show Source

• Array of: object publicWorkers-assignments-representatives-item-response

{
    "title":"Representatives",
    "type":"array",
    "description":"The representatives resource is a child of the assignments resource. It includes all the worker representatives as of the current date.",
    "items":{
        "$ref":"#/components/schemas/publicWorkers-assignments-representatives-item-response"
    }
}

Nested Schema : publicWorkers-assignments-allReports-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  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: 30

  Assignment number of the report.
• DepartmentId: integer (int64)
  Title: Department ID

  Read Only: true

  Unique identifier of the department that the report belongs to.
• 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.
• Level: integer (int32)
  Title: Level

  Read Only: true

  Level of the report in the manager's hierarchy.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  Title: Location ID

  Read Only: true

  Unique identifier for the location of the report.
• ManagerAssignmentNumber: string
  Title: Manager Assignment Number

  Read Only: true

  Maximum Length: 30

  Assignment number of the immediate manager of each report.
• ManagerPersonNumber: string
  Title: Manager Person Number

  Read Only: true

  Maximum Length: 30

  Person number of the immediate manager of each report.
• PersonId: integer (int64)
  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 representative photo.
• PhotoName: string
  Title: Photo Name

  Maximum Length: 240

  Name of the image file of the representative.
• 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 the 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 Non-worker (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 the managerial relationship with the report, such as line manager.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"Person's first name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"Unique identifier for the location of the report.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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":true
        },
        "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":false,
            "x-queryable":true
        },
        "ManagerPersonNumber":{
            "title":"Manager Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the immediate manager of each report.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PhotoId":{
            "title":"Photo ID",
            "type":"integer",
            "description":"Surrogate identifier for the representative photo.",
            "format":"int64",
            "nullable":false,
            "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 Non-worker (N).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerAssignmentNumber":{
            "title":"Manager Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Assignment number of the immediate manager of each report.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonId":{
            "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":{
            "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":30,
            "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"
            }
        },
        "Level":{
            "title":"Level",
            "type":"integer",
            "description":"Level of the report in the manager's hierarchy.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Department ID",
            "type":"integer",
            "description":"Unique identifier of the department that the report belongs to.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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 of the  representative.",
            "nullable":false,
            "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."
        }
    }
}

Nested Schema : publicWorkers-assignments-allReportsDepartments-item-response

Type: object

Show Source

• DepartmentId: integer (int64)
  Title: Department ID

  Read Only: true

  Unique identifier for the department.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 240

  Display name of the department manager.
• ManagerFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  First name of the department manager.
• ManagerKnownAs: string
  Title: Known As

  Read Only: true

  Maximum Length: 80

  Person's preferred name.
• ManagerLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  Last name of the department manager.
• ManagerPersonId: string
  Title: Manager ID

  Read Only: true

  Maximum Length: 150

  Internal identifier for the department manager.
• ManagerPersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Person number of the department manager.
• Name: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the department.
• PhotoId: integer (int64)
  Title: Photo ID

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

  Maximum Length: 240

  Name of the image file.
• WorkerCount: number
  Title: Total Workers

  Read Only: true

  Count of workers in the department.

{
    "type":"object",
    "properties":{
        "PhotoId":{
            "title":"Photo ID",
            "type":"integer",
            "description":"Surrogate identifier for the photo.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ManagerFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"First name of the department manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the department manager.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DepartmentId":{
            "title":"Department ID",
            "type":"integer",
            "description":"Unique identifier for the department.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkerCount":{
            "title":"Total Workers",
            "type":"number",
            "description":"Count of workers in the department.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ManagerPersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the department manager.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerPersonId":{
            "title":"Manager ID",
            "maxLength":150,
            "type":"string",
            "description":"Internal identifier for the department manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerDisplayName":{
            "title":"Manager",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the department manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerKnownAs":{
            "title":"Known As",
            "maxLength":80,
            "type":"string",
            "description":"Person's preferred name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhotoName":{
            "title":"Photo Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the image file.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the department.",
            "nullable":false,
            "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 : publicWorkers-assignments-allReportsLocations-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationCode: string
  Title: Location Code

  Read Only: true

  Maximum Length: 60

  Code of the location.
• LocationId: integer (int64)
  Title: Location ID

  Read Only: true

  Surrogate identifier for the location.
• LocationName: string
  Title: Location

  Read Only: true

  Maximum Length: 240

  Name of the location.
• WorkerCount: number
  Title: Total Workers

  Read Only: true

  Count of the workers in the location.

{
    "type":"object",
    "properties":{
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"Surrogate identifier for the location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationCode":{
            "title":"Location Code",
            "maxLength":60,
            "type":"string",
            "description":"Code of the location.",
            "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"
            }
        },
        "WorkerCount":{
            "title":"Total Workers",
            "type":"number",
            "description":"Count of the workers in the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LocationName":{
            "title":"Location",
            "maxLength":240,
            "type":"string",
            "description":"Name of the location.",
            "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 : 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 Non-worker (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 Non-worker (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 : publicWorkers-assignments-employmentHistory-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  Read Only: true

  Internal identifier for the worker's assignment.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 80

  Business title of the assignment.

{
    "type":"object",
    "properties":{
        "AssignmentId":{
            "type":"integer",
            "description":"Internal identifier for the worker's assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Business title of the assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : publicWorkers-assignments-managers-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "PositionName":{
            "title":"Position",
            "maxLength":240,
            "type":"string",
            "description":"Name of the position for the manager assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"Person's first name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerType":{
            "title":"Manager Type",
            "maxLength":30,
            "type":"string",
            "description":"Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "JobName":{
            "title":"Job",
            "maxLength":240,
            "type":"string",
            "description":"Name of the job for the manager assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KnownAs":{
            "title":"Known As",
            "maxLength":80,
            "type":"string",
            "description":"Person's preferred name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Photo":{
            "title":"Image",
            "type":"string",
            "description":"Unique location of the image. Encrypted version of the file.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "WorkEmail":{
            "title":"Work Email",
            "maxLength":240,
            "type":"string",
            "description":"Manager's work e-mail address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerPersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person Number of the supervisor.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerAssignmentId":{
            "title":"Manager Assignment ID",
            "type":"integer",
            "description":"Surrogate identifier for the assignment supervisor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PhotoId":{
            "title":"Photo ID",
            "type":"integer",
            "description":"Surrogate identifier for the supervisor photo.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentSupervisorId":{
            "title":"Assignment Supervisor ID",
            "type":"integer",
            "description":"Surrogate identifier for the supervisor on workers assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ManagerAssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Assignment number of the supervisor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerAssignmentName":{
            "title":"Assignment Name",
            "maxLength":80,
            "type":"string",
            "description":"Assignment name of the supervisor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerTypeMeaning":{
            "title":"Manager Type",
            "maxLength":80,
            "type":"string",
            "description":"Name of the role the supervisor has with regards to the overall organization structure, such as functional, project leader, and so on.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the job for the manager assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Person's display name.",
            "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
        },
        "PositionCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the position for the manager assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerPersonId":{
            "title":"Manager ID",
            "type":"integer",
            "description":"Surrogate identifier for the supervisor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PhotoName":{
            "title":"Photo Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the image file of the supervisor.",
            "nullable":false,
            "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 : publicWorkers-assignments-representatives-item-response

Type: object

Show Source

• AsgResponsibilityId: integer (int64)
  Read Only: true

  Internal identifier for the responsibitity.
• AssignmentNumber: string
  Title: Assignment Number

  Read Only: true

  Maximum Length: 30

  Assignment number of the representative.
• DisplayName: string
  Title: Display Name

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 150

  Person's first name.
• FromDate: string (date)
  Title: From Date

  Read Only: true

  Date when the responsibility starts.
• 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)
  Read Only: true

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

  Read Only: true

  Maximum Length: 30

  Person number of the representative.
• 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 representative photo.
• PhotoName: string
  Title: Photo Name

  Maximum Length: 240

  Name of the image file of the representative.
• ResponsibilityName: string
  Title: Responsibility Name

  Read Only: true

  Maximum Length: 240

  Name of the responsibility type of the representative such as Benefits Representative.
• ResponsibilityType: string
  Title: Responsibility Type

  Read Only: true

  Maximum Length: 80

  Responsibility type of the representative such as Human Resource Representative.
• ToDate: string (date)
  Title: To Date

  Read Only: true

  Date when the responsibility ends.
• Usage: string
  Read Only: true

  Maximum Length: 4000

  Description of the purpose for the responsibility.
• WorkContactsFlag: boolean
  Title: Work Contacts

  Read Only: true

  Maximum Length: 30

  Indicates whether the representatives should be displayed.
• WorkEmail: string
  Title: Work Email

  Read Only: true

  Maximum Length: 240

  Representative's work e-mail address.

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the representative.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Usage":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the purpose for the responsibility.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"Person's first name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkContactsFlag":{
            "title":"Work Contacts",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the representatives should be displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KnownAs":{
            "title":"Known As",
            "maxLength":80,
            "type":"string",
            "description":"Person's preferred name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Photo":{
            "title":"Image",
            "type":"string",
            "description":"Unique location of the image. Encrypted version of the file.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "ResponsibilityName":{
            "title":"Responsibility Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the responsibility type of the representative such as Benefits Representative.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkEmail":{
            "title":"Work Email",
            "maxLength":240,
            "type":"string",
            "description":"Representative's work e-mail address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhotoId":{
            "title":"Photo ID",
            "type":"integer",
            "description":"Surrogate identifier for the representative photo.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Internal identifier for the representative.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AsgResponsibilityId":{
            "type":"integer",
            "description":"Internal identifier for the responsibitity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the representative.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Assignment number of the representative.",
            "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"
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date when the responsibility starts.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"Date when the responsibility ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Person's last name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponsibilityType":{
            "title":"Responsibility Type",
            "maxLength":80,
            "type":"string",
            "description":"Responsibility type of the representative such as Human Resource Representative.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhotoName":{
            "title":"Photo Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the image file of the  representative.",
            "nullable":false,
            "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"
    }
}

Links

allReports

Operation: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReports

Parameters:

• AssignmentId: $request.path.AssignmentId
• PersonId: $request.path.PersonId

The allReports resource is a child of the assignments resource. It includes all the reports of a worker as of the current date for a specific assignment.

allReportsDepartments

Operation: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReportsDepartments

Parameters:

• AssignmentId: $request.path.AssignmentId
• PersonId: $request.path.PersonId

The allReportsDepartments resource is a child of the assignments resource. It includes all the distinct departments that all the reports of a worker belong to, as of the system date for a specific assignment.

allReportsLocations

Operation: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReportsLocations

Parameters:

• AssignmentId: $request.path.AssignmentId
• PersonId: $request.path.PersonId

The allReportsLocations resource is a child of the assignments resource. It includes all the distinct locations that all the reports of a worker belong to, as of the system date for a specific assignment.

directReports

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

Parameters:

• AssignmentId: $request.path.AssignmentId
• PersonId: $request.path.PersonId

The directReports resource is a child of the assignments resource. It includes all the direct reports of a worker as of the system date for a specific assignment.

employmentHistory

Operation: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/employmentHistory

Parameters:

• AssignmentId: $request.path.AssignmentId
• PersonId: $request.path.PersonId

The employmentHistory resource is a child of the assignments resource. It includes the employment history of a worker.

managers

Operation: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/managers

Parameters:

• AssignmentId: $request.path.AssignmentId
• PersonId: $request.path.PersonId

The managers resource is a child of the assignments resource. It includes all the managers of a worker.

representatives

Operation: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/representatives

Parameters:

• AssignmentId: $request.path.AssignmentId
• PersonId: $request.path.PersonId

The representatives resource is a child of the assignments resource. It includes all the worker representatives as of the current date.

Back to Top

Examples

The following example shows how to retrieve a worker assignment by submitting a GET request on the REST resource using cURL.

curl  -i -u ""<username>:<password> -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/publicWorkers/100100058800293/child/assignments/300100122995192"

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "AssignmentId": 300100122995192,
    "AssignmentNumber": "ASSIGN226333706774",
    "AssignmentName": "ASSIGN226333706774",
    "LegalEmployerName": "Vision Corporation UK",
    "StartDate": "2016-01-01",
    "PrimaryFlag": false,
    "PrimaryAssignmentFlag": true,
    "WorkerType": "E",
    "WorkerNumber": "56CAN26333706774",
    "WorkAtHomeFlag": true,
    "ManagerName": null,
    "BusinessUnitName": "Vision Corporation Enterprise",
    "DepartmentName": null,
    "JobName": null,
    "PositionName": null,
    "LocationName": "ZHRX_US_Florence KY",
    "InternalBuilding": null,
    "InternalFloor": null,
    "InternalOfficeNumber": null,
    "InternalMailstop": null,
    "LocationAddressLine1": "123 Main St",
    "LocationAddressLine2": null,
    "LocationAddressLine3": null,
    "LocationAddressLine4": null,
    "LocationRegion1": "BOONE",
    "LocationRegion2": "KY",
    "LocationRegion3": null,
    "LocationTownOrCity": "FLORENCE",
    "LocationPostalCode": "41022",
    "LocationCountry": "US",
    "LocationLongPostalCode": null,
    "LocationTimezoneCode": null,
    "links": [5]
       {
          ...}
     ]
}

Back to Top