Skip to main content

AssignmentModifiableFields

Fields that can be modified on an Assignment.

custom_fields object

An object with Custom Fields for this record. The key is the field ID and the value a description of the field. Additional details here: CustomFields Schema

tip

Updating Custom Field values

When creating or updating an existing object that uses Custom Fields, for example a User record, you can follow this custom_field key structure to update the custom field values. The value field is the only required field for updating a custom field value; other fields such as pname will be ignored.

info

Important: depending on the endpoint, this may 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 detailed 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 and char 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.

Note that when modifying Custom Fields of objects like Users or Projects, only the value key will be checked; other fields like the Custom Field pname will be ignored.

Example: XYZ Pay Group

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

AssignmentModifiableFields
{
  "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"
    }
  }
}