Assignment

An Assignment is an artifact of a work assignment to a PX Task given to either a User or a Team.

iduuid

The internal ID of the resource or object.

In general, the id field is the primary key of the object and cannot be changed or updated.

Example: 64BBA147B9AC41D9978062300826C89F

uriuri-reference

The URI associated with this resource. This is usually a relative URL that can be used to access the resource. Typically it incorporates the Unique ID of the resource.

Example: /api/v1/objects/64BBA147B9AC41D9978062300826C89F

tablenamestring

The name of the internal database table associated with this resource.

Example: users

table_labelstring

The user-visible label of the database table associated with this object.

Example: codes_pay_types

pnamestring

The name of the assignment.

Example: Documentation for Project XYZ

id_groupstring

The internal ID of the group associated with this Assignment.

Example: C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1

id_projectstring

The internal ID of the project associated with this Assignment.

Example: C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1

id_requisitionstring

The internal ID of the requisition associated with this Assignment, if any.

Example: C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1

id_rolestring

The internal ID of the role associated with this Assignment.

Example: C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1

id_teamstring

The internal ID of the team associated with this Assignment, if any.

Example: C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1

id_userstring

The internal ID of the user associated with this Assignment.

Example: C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1

is_managedboolean

Whether the Assignment is managed. A managed assignment has the start/end dates automatically managed based on the underlying PX Task.

Example: true

actual_durationnumber

The actual duration of the assignment in days.

actual_endnumber

The actual end date and time of the assignment in Unix epoch format.

actual_startnumber

The actual start date and time of the assignment in Unix epoch format.

actual_worknumber

The actual work hours of the assignment.

actual_work_updatednumber

The date and time (in Unix epoch format) when the actual work hours were last updated.

duration_variancenumber

The variance between the scheduled and actual duration of the assignment in days.

scheduled_durationnumber

The scheduled duration of the assignment in days.

Example: 40

scheduled_endnumber

The scheduled end date and time of the assignment in Unix epoch format.

Example: 1681430400

scheduled_startnumber

The scheduled start date and time of the assignment in Unix epoch format.

Example: 1681372800

scheduled_worknumber

The scheduled work hours of the assignment.

Example: 40

estimated_worknumber

The estimate work hours for the assignment.

Example: 125

estimated_work1number

Internal field.

Example: 0

estimated_work2number

Internal field.

Example: 0

msp_assignment_idstring

The ID of the assignment for an external accounting system.

msp_file_idstring

The ID of the file for an external accounting system.

start_variancenumber

The variance between the scheduled and actual start dates.

Example: 0

end_variancenumber

The variance between the scheduled and actual end dates.

Example: 0

work_variancenumber

The variance between the scheduled and actual work hours.

Example: 0

utilizationnumber

The utilization percentage for this resource on the assignment.

daily_loadnumber

The daily load for the assignment.

Example: 4

custom_fields object

A map of custom fields. The key is the field ID and the value a description of the field.

Important: this will only be included in the response if $keys=custom_fields or $keys=$extended was set as a query parameter.

There is also a more compact representation available in most object types, where each custom field value is a separate key in the main object (not under custom_fields).

See the CustomFields schema page for more information on these topics.

property name* CustomFieldValue

A specific instance (value) of a Custom field for a particular object.

id_attr_typestring

The unique internal ID of this Custom Field definition (same as id field)

Example: 2DDD372DC4D3422D9E73F6DE936C4265

attr_typestring

Datatype of the custom field. The basic types available are:

STRING - a variable-length string.
CHAR - a fixed-length string. (The value may be padded with spaces.)
NUMBER - a floating-point number.
INTEGER - an integer (whole number).
TIMESTAMP - a date and time, stored in Unix epoch format.
DATE - a YYYYMMDD (F8) date.

In addition, most types can be modified with a prefix to indicate whether they are "select lists" (ENUM or enumerated) or "multi-select lists" (M_ENUM) which can take on multiple values.

Strings may also have a maximum length specified, such as STRING_100.

Example: ["STRING_100","ENUM_STRING_20","M_ENUM_STRING_252","ENUM_INTEGER","NUMBER"]

descriptionstring

Description of custom field

pnamestring

Name of custom field

Example: Pay Group

id_attr_type_uristring

URI of the custom field to get more information about the custom field definition.

Example: /api/v1/custom_fields/E07526A217164D1B94188279A8A0E4D9

valuestring

Value of the custom field for this object. To update the value, see the note on the CustomFields schema page.

Example: XYZ Pay Group

creatorstring

The internal User ID of the user who created the object.

Example: 64BBA147B9AC41D9978062300826C89F

creator_fullnamestring

The full name of the user who created the object.

Example: John Doe

creator_properties object

Extended information about the User who created the object. This field is only included if the $keys parameter requests it.

expense_guistring

The ID of the user's assigned Expense entry screen configuration.

time_guistring

The ID of the user's assigned time entry screen configuration.

travel_guistring

The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

daysinlistinteger

UNUSED FIELD This is a legacy field that is no longer used.

emailstring

The email address of the user.

Note: This is a read-only field. To change the user's email address, you must modify the users_attribs:users_email field.

first_namestring

The first name of the user.

Note: read-only; set via the fullname field.

id_userstring

The unique internal ID of this user. (Same as id.)

Example: 5CD906A3941C463B9CC98F49DBCC25AA

last_namestring

The last name of the user.

Note: read-only; set via the fullname field.

memorized_sheet_choices object[]

A list of memorized timesheets associated with the user.

These are the choices available to set in the default_memorized_sheet field.

Array [

valuestring

The internal ID of the memorized timesheet.

textstring

The name of the memorized timesheet.

]

reserved1string

UNUSED FIELD This is a legacy field that is no longer used.

reserved2float

UNUSED FIELD This is a legacy field that is no longer used.

reserved3float

UNUSED FIELD This is a legacy field that is no longer used.

timerecs_outinteger

UNUSED FIELD This is a legacy field that is no longer used.

time_gui_propertiesobject

Details about the user's assigned time entry screen configuration.

travel_gui_propertiesobject

Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

expense_gui_propertiesobject

Details about the user's assigned Expense entry screen configuration.

create_timestampfloat

The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

create_timestamp_date_longstring

The object creation date in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023

create_timestamp_date_shortstring

The object creation date in the "short date" format defined in the system settings.

Example: 03/22/2023

create_timestamp_datetime_longstring

The object creation date and time in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023 12:18:46 CDT

create_timestamp_datetime_shortstring

The object creation date and time in the "short date" format defined in the system settings.

Example: 03/22/2023 12:18:46 CDT

create_timestamp_isodate-time

The creation timestamp in ISO 8601 format.

Example: 2023-03-22T12:18:46-05:00

modifierstring

The internal User ID of the user who most recently modified the object.

Example: 64BBA147B9AC41D9978062300826C89F

modifier_fullnamestring

The full name of the user who most recently modified the object.

Example: John Doe

modifier_properties object

Extended information about the User who last modified the object. This field is only included if the $keys parameter requests it.

expense_guistring

The ID of the user's assigned Expense entry screen configuration.

time_guistring

The ID of the user's assigned time entry screen configuration.

travel_guistring

The ID of the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

daysinlistinteger

UNUSED FIELD This is a legacy field that is no longer used.

emailstring

The email address of the user.

Note: This is a read-only field. To change the user's email address, you must modify the users_attribs:users_email field.

first_namestring

The first name of the user.

Note: read-only; set via the fullname field.

id_userstring

The unique internal ID of this user. (Same as id.)

Example: 5CD906A3941C463B9CC98F49DBCC25AA

last_namestring

The last name of the user.

Note: read-only; set via the fullname field.

memorized_sheet_choices object[]

A list of memorized timesheets associated with the user.

These are the choices available to set in the default_memorized_sheet field.

Array [

valuestring

The internal ID of the memorized timesheet.

textstring

The name of the memorized timesheet.

]

reserved1string

UNUSED FIELD This is a legacy field that is no longer used.

reserved2float

UNUSED FIELD This is a legacy field that is no longer used.

reserved3float

UNUSED FIELD This is a legacy field that is no longer used.

timerecs_outinteger

UNUSED FIELD This is a legacy field that is no longer used.

time_gui_propertiesobject

Details about the user's assigned time entry screen configuration.

travel_gui_propertiesobject

Details about the user's assigned Custom Entry (a.k.a. Mileage or Travel) entry screen configuration.

expense_gui_propertiesobject

Details about the user's assigned Expense entry screen configuration.

modify_timestampfloat

The timestamp when the object was most recently modified, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

modify_timestamp_date_longstring

The last modification date in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023

modify_timestamp_date_shortstring

The last modification date in the "short date" format defined in the system settings.

Example: 03/22/2023

modify_timestamp_datetime_longstring

The last modification date and time in the "long date" format defined in the system settings.

Example: Wednesday, March 22, 2023 12:18:46 CDT

modify_timestamp_datetime_shortstring

The last modification date and time in the "short date" format defined in the system settings.

Example: 03/22/2023 12:18:46 CDT

modify_timestamp_isodate-time

The last modification timestamp in ISO 8601 format.

Example: 2023-03-22T12:18:46-05:00

id_domainstring

The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.

Example: install_root_dom

id_assignmentstring

The unique internal ID of the Assignment. (Same as id field.)

alerts object[]

An array of alerts associated with this Assignment.

Array [

assn_target_is_teamboolean

Whether the Assignment target is a Team.

assn_target_is_userboolean

Whether the Assignment target is a User.

assn_target_pnamestring

The name of the Assignment target (user or team).

assn_urlstring

The URL of the Assignment related to this alert.

id_assnstring

The internal ID of the related Assignment.

id_assn_targetstring

The internal ID of the Assignment target (user or team).

is_alertboolean

Whether this alert is an alert.

is_warningboolean

Whether this alert is a warning.

messagestring

Example: Assignment completion overdue 49 day(s).

]

assn_typestring

A human readable description of the type of the Assignment.

Example: Direct assignment to user User XYZ

is_team_assignmentboolean

Whether the Assignment is assigned to a Team.

Example: false

is_user_assignmentboolean

Whether the Assignment is assigned to a User.

Example: true

project_backup_owner_idstring

The internal User ID of the backup owner of the project associated with this Assignment.

Example: C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1

project_backup_owner_pnamestring

The name of the backup owner of the project associated with this Assignment.

Example: User XYZ

project_owner_idstring

The internal User ID of the owner of the project associated with this Assignment.

Example: C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1

project_owner_pnamestring

The name of the owner of the project associated with this Assignment.

Example: User XYZ

project_pnamestring

The name of the project associated with this Assignment.

Example: Project XYZ

resource_overhead_hoursnumber

The number of overhead hours for the resource associated with this Assignment.

Example: 12

resource_work_daysnumber

The number of work days for the resource associated with this Assignment.

Example: 5

resource_work_hoursnumber

The number of work hours for the resource associated with this Assignment.

Example: 40

target_pnamestring

The name of the target (user or team) of the Assignment.

Example: User XYZ

top_level_project_idstring

The internal ID of the top level project associated with this Assignment.

Example: C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1

top_level_project_pnamestring

The name of the top level project associated with this Assignment.

Example: Project XYZ

Assignment
{
  "id_assignment": "string",
  "alerts": [
    {
      "assn_target_is_team": true,
      "assn_target_is_user": true,
      "assn_target_pname": "string",
      "assn_url": "string",
      "id_assn": "string",
      "id_assn_target": "string",
      "is_alert": true,
      "is_warning": true,
      "message": "Assignment completion overdue 49 day(s)."
    }
  ],
  "assn_type": "Direct assignment to user User XYZ",
  "is_team_assignment": false,
  "is_user_assignment": true,
  "project_backup_owner_id": "C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1",
  "project_backup_owner_pname": "User XYZ",
  "project_owner_id": "C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1",
  "project_owner_pname": "User XYZ",
  "project_pname": "Project XYZ",
  "resource_overhead_hours": 12,
  "resource_work_days": 5,
  "resource_work_hours": 40,
  "target_pname": "User XYZ",
  "top_level_project_id": "C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1",
  "top_level_project_pname": "Project XYZ",
  "id": "64BBA147B9AC41D9978062300826C89F",
  "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
  "tablename": "users",
  "table_label": "codes_pay_types",
  "pname": "Documentation for Project XYZ",
  "id_group": "C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1",
  "id_project": "C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1",
  "id_requisition": "C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1",
  "id_role": "C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1",
  "id_team": "C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1",
  "id_user": "C3C2B2D1A1E24E6B9E5A1D3C2B2D1A1",
  "is_managed": true,
  "actual_duration": 0,
  "actual_end": 0,
  "actual_start": 0,
  "actual_work": 0,
  "actual_work_updated": 0,
  "duration_variance": 0,
  "scheduled_duration": 40,
  "scheduled_end": 1681430400,
  "scheduled_start": 1681372800,
  "scheduled_work": 40,
  "estimated_work": 125,
  "estimated_work1": 0,
  "estimated_work2": 0,
  "msp_assignment_id": "string",
  "msp_file_id": "string",
  "start_variance": 0,
  "end_variance": 0,
  "work_variance": 0,
  "utilization": 0,
  "daily_load": 4,
  "custom_fields": {
    "C41B2DDA662F4EF6B730F9CB6DB04696": {
      "attr_type": "ENUM_STRING_252",
      "description": "Employee pay group.",
      "id_attr_type": "C41B2DDA662F4EF6B730F9CB6DB04696",
      "id_attr_type_uri": "/api/v1/custom_fields/C41B2DDA662F4EF6B730F9CB6DB04696",
      "pname": "Pay Group",
      "value": "XYZ Pay Group"
    },
    "users_email": {
      "attr_type": "STRING_252",
      "description": "Email address",
      "id_attr_type": "users_email",
      "id_attr_type_uri": "/api/v1/custom_fields/users_email",
      "pname": "Email Address",
      "value": "username@example.com"
    }
  },
  "creator": "64BBA147B9AC41D9978062300826C89F",
  "creator_fullname": "John Doe",
  "creator_properties": {
    "expense_gui": "string",
    "time_gui": "string",
    "travel_gui": "string",
    "daysinlist": 0,
    "email": "string",
    "first_name": "string",
    "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
    "last_name": "string",
    "memorized_sheet_choices": [
      {
        "value": "string",
        "text": "string"
      }
    ],
    "reserved1": "string",
    "reserved2": 0,
    "reserved3": 0,
    "timerecs_out": 0,
    "time_gui_properties": {},
    "travel_gui_properties": {},
    "expense_gui_properties": {}
  },
  "create_timestamp": 1696021987.01375,
  "create_timestamp_date_long": "Wednesday, March 22, 2023",
  "create_timestamp_date_short": "03/22/2023",
  "create_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
  "create_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
  "create_timestamp_iso": "2023-03-22T12:18:46-05:00",
  "modifier": "64BBA147B9AC41D9978062300826C89F",
  "modifier_fullname": "John Doe",
  "modifier_properties": {
    "expense_gui": "string",
    "time_gui": "string",
    "travel_gui": "string",
    "daysinlist": 0,
    "email": "string",
    "first_name": "string",
    "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
    "last_name": "string",
    "memorized_sheet_choices": [
      {
        "value": "string",
        "text": "string"
      }
    ],
    "reserved1": "string",
    "reserved2": 0,
    "reserved3": 0,
    "timerecs_out": 0,
    "time_gui_properties": {},
    "travel_gui_properties": {},
    "expense_gui_properties": {}
  },
  "modify_timestamp": 1696021987.01375,
  "modify_timestamp_date_long": "Wednesday, March 22, 2023",
  "modify_timestamp_date_short": "03/22/2023",
  "modify_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
  "modify_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
  "modify_timestamp_iso": "2023-03-22T12:18:46-05:00",
  "id_domain": "install_root_dom"
}