Requisition

A Requisition represents a request for an assignment of a user (or team) to a particular PX Task.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

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

Example: 64BBA147B9AC41D9978062300826C89F

uristring<uri-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

id_projectstring

The internal ID of the Project that the Requisition is associated with. This can only be set at create time (POST) and cannot be updated.

Example: 20945205C94E4576B5FB798DA09B44DE

id_requesteestring

The internal ID of the user or team that the Requisition is requesting.

Example: 64BBA147B9AC41D9978062300826C89F

id_requestorstring

The internal ID of the user that is requesting the Requisition.

Example: 64BBA147B9AC41D9978062300826C89F

request_datenumber

The date that the Requisition was created. This is a Unix timestamp.

Example: 1681776000

response_datenumber

The date that the Requisition was responded to. This is a Unix timestamp.

Example: 1681796000

statestring

The current state of the Requisition. The options are:

• open - the Requisition has been created and is awaiting a response
• fulfilled - the Requisition has been accepted and the assignment has been created
• declined - the Requisition has been declined
• discussion - the Requisition is in discussion

Possible values: [open, fulfilled, declined, discussion]

Example: open

commentstring

A comment that can be added to the Requisition.

notify_requesteeboolean

If true, the requestee will be notified when the Requisition is created or updated.

notify_requestorboolean

If true, the requestor will be notified when the Requisition is responded to.

id_assignmentstring

The internal ID of the Assignment that was created from this Requisition. This is only set when the Requisition is fulfilled.

scheduled_endnumber

The scheduled end date of the assignment. This is a Unix timestamp.

Example: 1679616000

scheduled_startnumber

The scheduled start date of the assignment. This is a Unix timestamp.

Example: 1678060800

scheduled_worknumber

The scheduled work hours for the assignment.

Example: 40

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.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

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

Example: 64BBA147B9AC41D9978062300826C89F

uristring<uri-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

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

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

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

idstring

The Group ID (32-character hexadecimal string).

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsstring[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

is_hiddenboolean

Indicates whether the object is hidden.

See also status

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The status of the user; either hidden, active, or inactive.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

• lr for Loggable and Reportable
• ro for Reportable Only
• h for Hidden

Possible values: [lr, ro, h]

Example: lr

user_loginstringrequired

The login name of the user.

Example: john.smith@example.com

fullnamestringrequired

The full name of the user.

Example: John Smith

u_commentstring

The default comment on the user's time entry screen.

default_memorized_sheetstring

The ID of the user's default memorized timesheet.

dropdownthresholdinteger

The number of items in a selection list to trigger a forced search.

hideboolean

Indicates whether the user is hidden.

Note: the User object is the only one that uses this field; other objects use is_hidden.

expire_new_pwboolean

Whether the user's new password should expire after the first login.

This is a write-only field that does not appear in User object responses.

new_pwstring

The new password for the user.

The password must also be set in the new_pw2 field to confirm the change.

This is a write-only field that does not appear in User object responses.

new_pw2string

The new password for the user, repeated to confirm the change.

The password must also be set in the new_pw field to confirm the change.

This is a write-only field that does not appear in User object responses.

rolesstring[]

A list of role IDs belonging to this user.

This list can be modified to change the user's roles.

timerecs_ininteger

The number of blank rows to show on the entry screen.

Example: 3

time_periodstring

The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

Example: default_weekly

expense_periodstring

The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

Example: default_weekly

custom_periodstring

The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

Example: default_weekly

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.

create_timestampnumber<float>

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_isostring<date-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_propertiesobject

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

modify_timestampnumber<float>

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_isostring<date-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

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, or custom_fields.users_email.value.

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.

reserved2number<float>

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

reserved3number<float>

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_timestampnumber<float>

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_isostring<date-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.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

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

Example: 64BBA147B9AC41D9978062300826C89F

uristring<uri-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

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

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

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

idstring

The Group ID (32-character hexadecimal string).

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsstring[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

is_hiddenboolean

Indicates whether the object is hidden.

See also status

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The status of the user; either hidden, active, or inactive.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

• lr for Loggable and Reportable
• ro for Reportable Only
• h for Hidden

Possible values: [lr, ro, h]

Example: lr

user_loginstringrequired

The login name of the user.

Example: john.smith@example.com

fullnamestringrequired

The full name of the user.

Example: John Smith

u_commentstring

The default comment on the user's time entry screen.

default_memorized_sheetstring

The ID of the user's default memorized timesheet.

dropdownthresholdinteger

The number of items in a selection list to trigger a forced search.

hideboolean

Indicates whether the user is hidden.

Note: the User object is the only one that uses this field; other objects use is_hidden.

expire_new_pwboolean

Whether the user's new password should expire after the first login.

This is a write-only field that does not appear in User object responses.

new_pwstring

The new password for the user.

The password must also be set in the new_pw2 field to confirm the change.

This is a write-only field that does not appear in User object responses.

new_pw2string

The new password for the user, repeated to confirm the change.

The password must also be set in the new_pw field to confirm the change.

This is a write-only field that does not appear in User object responses.

rolesstring[]

A list of role IDs belonging to this user.

This list can be modified to change the user's roles.

timerecs_ininteger

The number of blank rows to show on the entry screen.

Example: 3

time_periodstring

The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

Example: default_weekly

expense_periodstring

The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

Example: default_weekly

custom_periodstring

The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

Example: default_weekly

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.

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_propertiesobject

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

create_timestampnumber<float>

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_isostring<date-time>

The creation timestamp in ISO 8601 format.

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

modify_timestampnumber<float>

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_isostring<date-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

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, or custom_fields.users_email.value.

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.

reserved2number<float>

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

reserved3number<float>

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_timestampnumber<float>

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_isostring<date-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_requisitionstring

The internal ID of the Requisition. This is the same as the id field.

Example: 150B0C860670432E82D39F14F98DD2F3

pnamestring

The name of the Requisition. This is generated and cannot be modified.

Example: Task XYZ

assignment_pnamestring

The name of the Assignment that was created from this Requisition. This is generated and cannot be modified.

Example: Task XYZ

descriptionstring

The description of the Requisition as shown to the Requestee.

Example: Requisition for Task XYZ

history_urlstring<uri-reference>

The URL to the history of the Requisition.

Example: notes.pyc?viewnote=F6668AA582574475A6FE5D1CC501F795&bday=19710101&eday=20131214

id_assignment_properties object

The properties of the Assignment that was created from this Requisition. This is only included if requested in $keys.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

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

Example: 64BBA147B9AC41D9978062300826C89F

uristring<uri-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

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

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

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.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

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

Example: 64BBA147B9AC41D9978062300826C89F

uristring<uri-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

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

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

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

idstring

The Group ID (32-character hexadecimal string).

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsstring[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

is_hiddenboolean

Indicates whether the object is hidden.

See also status

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The status of the user; either hidden, active, or inactive.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

• lr for Loggable and Reportable
• ro for Reportable Only
• h for Hidden

Possible values: [lr, ro, h]

Example: lr

user_loginstringrequired

The login name of the user.

Example: john.smith@example.com

fullnamestringrequired

The full name of the user.

Example: John Smith

u_commentstring

The default comment on the user's time entry screen.

default_memorized_sheetstring

The ID of the user's default memorized timesheet.

dropdownthresholdinteger

The number of items in a selection list to trigger a forced search.

hideboolean

Indicates whether the user is hidden.

Note: the User object is the only one that uses this field; other objects use is_hidden.

expire_new_pwboolean

Whether the user's new password should expire after the first login.

This is a write-only field that does not appear in User object responses.

new_pwstring

The new password for the user.

The password must also be set in the new_pw2 field to confirm the change.

This is a write-only field that does not appear in User object responses.

new_pw2string

The new password for the user, repeated to confirm the change.

The password must also be set in the new_pw field to confirm the change.

This is a write-only field that does not appear in User object responses.

rolesstring[]

A list of role IDs belonging to this user.

This list can be modified to change the user's roles.

timerecs_ininteger

The number of blank rows to show on the entry screen.

Example: 3

time_periodstring

The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

Example: default_weekly

expense_periodstring

The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

Example: default_weekly

custom_periodstring

The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

Example: default_weekly

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.

create_timestampnumber<float>

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_isostring<date-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_propertiesobject

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

modify_timestampnumber<float>

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_isostring<date-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

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, or custom_fields.users_email.value.

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.

reserved2number<float>

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

reserved3number<float>

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_timestampnumber<float>

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_isostring<date-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.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

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

Example: 64BBA147B9AC41D9978062300826C89F

uristring<uri-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

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

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

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

idstring

The Group ID (32-character hexadecimal string).

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsstring[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

is_hiddenboolean

Indicates whether the object is hidden.

See also status

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The status of the user; either hidden, active, or inactive.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

• lr for Loggable and Reportable
• ro for Reportable Only
• h for Hidden

Possible values: [lr, ro, h]

Example: lr

user_loginstringrequired

The login name of the user.

Example: john.smith@example.com

fullnamestringrequired

The full name of the user.

Example: John Smith

u_commentstring

The default comment on the user's time entry screen.

default_memorized_sheetstring

The ID of the user's default memorized timesheet.

dropdownthresholdinteger

The number of items in a selection list to trigger a forced search.

hideboolean

Indicates whether the user is hidden.

Note: the User object is the only one that uses this field; other objects use is_hidden.

expire_new_pwboolean

Whether the user's new password should expire after the first login.

This is a write-only field that does not appear in User object responses.

new_pwstring

The new password for the user.

The password must also be set in the new_pw2 field to confirm the change.

This is a write-only field that does not appear in User object responses.

new_pw2string

The new password for the user, repeated to confirm the change.

The password must also be set in the new_pw field to confirm the change.

This is a write-only field that does not appear in User object responses.

rolesstring[]

A list of role IDs belonging to this user.

This list can be modified to change the user's roles.

timerecs_ininteger

The number of blank rows to show on the entry screen.

Example: 3

time_periodstring

The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

Example: default_weekly

expense_periodstring

The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

Example: default_weekly

custom_periodstring

The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

Example: default_weekly

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.

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_propertiesobject

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

create_timestampnumber<float>

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_isostring<date-time>

The creation timestamp in ISO 8601 format.

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

modify_timestampnumber<float>

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_isostring<date-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

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, or custom_fields.users_email.value.

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.

reserved2number<float>

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

reserved3number<float>

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_timestampnumber<float>

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_isostring<date-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

id_project_properties object

The properties of the Project that the Requisition is associated with. This is only included if requested in $keys.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

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

Example: 64BBA147B9AC41D9978062300826C89F

uristring<uri-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

is_hiddenboolean

Indicates whether the object is hidden.

See also status

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The general visibility status of the object; either Hidden, Loggable and Reportable, or Reportable Only.

This is a write-enabled field if you have the appropriate permissions. See also status_code which can be changed in the same way.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

• lr for Loggable and Reportable
• ro for Reportable Only
• h for Hidden

Possible values: [lr, ro, h]

Example: lr

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

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

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

idstring

The Group ID (32-character hexadecimal string).

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsstring[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

id_parentstringrequired

The internal ID of the parent Project. This can only be set when creating a new Project. The parent of an existing Project cannot be changed, except for "PX Task" type projects.

Example: 64BBA147B9AC41D9978062300826C89F

pnamestringrequired

The name of the Project.

Example: XYZ Project

descriptionstring

A description of the Project.

Example: This is a description of the XYZ Project.

hours_estimatenumber

The estimated number of hours for the Project.

Example: 100

percent_completenumber

The percentage of the Project that is complete.

Example: 50

project_typenumber

The Project Type code of the Project. Should be 1 for a normal Project. Types 4-12 are used for PX Scheduled Projects.

Example: 1

wbsstringnullable

UNUSED FIELD; normally null

Example: null

id_ownerstring

The internal ID of the User who is the owner of the Project. Note: changes to owners are automatically propagated to all descendants.

Example: 64BBA147B9AC41D9978062300826C89F

id_backupstring

The internal ID of the User who is the Backup Owner for the Project. Note: changes to owners are automatically propagated to all descendants.

Example: 64BBA147B9AC41D9978062300826C89F

rm_typenumber

UNUSED FIELD; normally 0

Example: 0

statenumber

UNUSED FIELD; normally 0

Example: 0

work_variancenumber

PX Scheduled Projects only: TODO: explain

Example: 0

start_variancenumber

PX Scheduled Projects only: TODO: explain

Example: 0

end_variancenumber

PX Scheduled Projects only: TODO: explain

Example: 0

duration_variancenumber

PX Scheduled Projects only: TODO: explain Integer number of days.

Example: 0

scheduled_worknumber

PX Scheduled Projects only: TODO: explain Number of hours.

Example: 0

scheduled_startnumber

PX Scheduled Projects only: The scheduled start date of the Project as an epoch timestamp.

Example: 1727724343

scheduled_endnumber

PX Scheduled Projects only: The scheduled end date of the Project as an epoch timestamp.

Example: 1727724343

scheduled_durationnumber

PX Scheduled Projects only: The scheduled duration of the Project in days.

Example: 10

projected_costnumber

The projected cost of the Project.

Example: 1000

projected_returnnumber

The projected return of the Project.

Example: 2000

projected_profitnumber

The projected profit of the Project.

Example: 1000

projected_roinumber

The projected return on investment of the Project.

Example: 2

awaiting_exportinteger

If 1, the Project is awaiting export in Projectlink. Does not apply to other integrations.

Example: 0

allow_timeboolean

If true, time can be logged against this Project.

Example: true

allow_expenseboolean

If true, expenses can be logged against this Project.

Example: true

allow_customboolean

If true, Custom Entry (a.k.a Mileage) entries can be logged against this Project.

Example: true

allow_leaveboolean

If true, Leave Request entries can be logged against this Project.

Example: true

allow_holidayboolean

If true, Holiday entries can be created using this Project.

Example: true

propagate_pa_ratesboolean

If true, the Project will propagate the "Project Activity" rates assigned to this Project to any new Projects created under this Project.

Example: true

multiple_assnsboolean

If true, Assignments can be made in "Multiple Assignment" mode using this Project.

Example: true

agile_team_assnsboolean

If true, Assignments can be made to a "Team" instead of an individual using this Project.

Example: true

dependencies_new_children_inheritboolean

If true, new child Projects will inherit the dependencies of this Project.

Example: true

dependencies_copy_to_descendentsboolean

If true, the dependencies of this Project will be copied to all descendants. Note: this field is spelled as descendents instead of descendants.

Example: true

dependencies object

A map of Project dependencies; when this Project is selected, only the listed choices in the dependent Entry Columns are available to the user.

The keys in this object should be the table name of the dependent Entry Code, e.g. codes_pay_types. The values should be arrays of Entry Code IDs that belong to that table. These will be the allowed choices when this Project is selected.

The list of available Entry Column tables is here: (TODO: provide link)

property name* string[]

A list of Entry Code IDs that belong to the table specified by the key, e.g. codes_bill_types.

Array [

string

]

change_requestsarray

A list of Change Requests associated with this Project. These are requests from team members to change the estimated hours left for the Project / Task.

autoaddboolean

If true, this Project is automatically added to new Groups as they are created.

Example: false

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.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

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

Example: 64BBA147B9AC41D9978062300826C89F

uristring<uri-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

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

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

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

idstring

The Group ID (32-character hexadecimal string).

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsstring[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

is_hiddenboolean

Indicates whether the object is hidden.

See also status

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The status of the user; either hidden, active, or inactive.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

• lr for Loggable and Reportable
• ro for Reportable Only
• h for Hidden

Possible values: [lr, ro, h]

Example: lr

user_loginstringrequired

The login name of the user.

Example: john.smith@example.com

fullnamestringrequired

The full name of the user.

Example: John Smith

u_commentstring

The default comment on the user's time entry screen.

default_memorized_sheetstring

The ID of the user's default memorized timesheet.

dropdownthresholdinteger

The number of items in a selection list to trigger a forced search.

hideboolean

Indicates whether the user is hidden.

Note: the User object is the only one that uses this field; other objects use is_hidden.

expire_new_pwboolean

Whether the user's new password should expire after the first login.

This is a write-only field that does not appear in User object responses.

new_pwstring

The new password for the user.

The password must also be set in the new_pw2 field to confirm the change.

This is a write-only field that does not appear in User object responses.

new_pw2string

The new password for the user, repeated to confirm the change.

The password must also be set in the new_pw field to confirm the change.

This is a write-only field that does not appear in User object responses.

rolesstring[]

A list of role IDs belonging to this user.

This list can be modified to change the user's roles.

timerecs_ininteger

The number of blank rows to show on the entry screen.

Example: 3

time_periodstring

The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

Example: default_weekly

expense_periodstring

The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

Example: default_weekly

custom_periodstring

The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

Example: default_weekly

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.

create_timestampnumber<float>

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_isostring<date-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_propertiesobject

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

modify_timestampnumber<float>

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_isostring<date-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

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, or custom_fields.users_email.value.

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.

reserved2number<float>

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

reserved3number<float>

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_timestampnumber<float>

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_isostring<date-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.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

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

Example: 64BBA147B9AC41D9978062300826C89F

uristring<uri-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

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

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

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

idstring

The Group ID (32-character hexadecimal string).

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsstring[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

is_hiddenboolean

Indicates whether the object is hidden.

See also status

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The status of the user; either hidden, active, or inactive.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

• lr for Loggable and Reportable
• ro for Reportable Only
• h for Hidden

Possible values: [lr, ro, h]

Example: lr

user_loginstringrequired

The login name of the user.

Example: john.smith@example.com

fullnamestringrequired

The full name of the user.

Example: John Smith

u_commentstring

The default comment on the user's time entry screen.

default_memorized_sheetstring

The ID of the user's default memorized timesheet.

dropdownthresholdinteger

The number of items in a selection list to trigger a forced search.

hideboolean

Indicates whether the user is hidden.

Note: the User object is the only one that uses this field; other objects use is_hidden.

expire_new_pwboolean

Whether the user's new password should expire after the first login.

This is a write-only field that does not appear in User object responses.

new_pwstring

The new password for the user.

The password must also be set in the new_pw2 field to confirm the change.

This is a write-only field that does not appear in User object responses.

new_pw2string

The new password for the user, repeated to confirm the change.

The password must also be set in the new_pw field to confirm the change.

This is a write-only field that does not appear in User object responses.

rolesstring[]

A list of role IDs belonging to this user.

This list can be modified to change the user's roles.

timerecs_ininteger

The number of blank rows to show on the entry screen.

Example: 3

time_periodstring

The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

Example: default_weekly

expense_periodstring

The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

Example: default_weekly

custom_periodstring

The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

Example: default_weekly

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.

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_propertiesobject

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

create_timestampnumber<float>

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_isostring<date-time>

The creation timestamp in ISO 8601 format.

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

modify_timestampnumber<float>

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_isostring<date-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

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, or custom_fields.users_email.value.

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.

reserved2number<float>

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

reserved3number<float>

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_timestampnumber<float>

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_isostring<date-time>

The last modification timestamp in ISO 8601 format.

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

id_requestee_properties object

The properties of the Requestee of the Requisition. This is only included if requested in $keys.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

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

Example: 64BBA147B9AC41D9978062300826C89F

uristring<uri-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

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

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

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

idstring

The Group ID (32-character hexadecimal string).

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsstring[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

is_hiddenboolean

Indicates whether the object is hidden.

See also status

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The status of the user; either hidden, active, or inactive.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

• lr for Loggable and Reportable
• ro for Reportable Only
• h for Hidden

Possible values: [lr, ro, h]

Example: lr

user_loginstringrequired

The login name of the user.

Example: john.smith@example.com

fullnamestringrequired

The full name of the user.

Example: John Smith

u_commentstring

The default comment on the user's time entry screen.

default_memorized_sheetstring

The ID of the user's default memorized timesheet.

dropdownthresholdinteger

The number of items in a selection list to trigger a forced search.

hideboolean

Indicates whether the user is hidden.

Note: the User object is the only one that uses this field; other objects use is_hidden.

expire_new_pwboolean

Whether the user's new password should expire after the first login.

This is a write-only field that does not appear in User object responses.

new_pwstring

The new password for the user.

The password must also be set in the new_pw2 field to confirm the change.

This is a write-only field that does not appear in User object responses.

new_pw2string

The new password for the user, repeated to confirm the change.

The password must also be set in the new_pw field to confirm the change.

This is a write-only field that does not appear in User object responses.

rolesstring[]

A list of role IDs belonging to this user.

This list can be modified to change the user's roles.

timerecs_ininteger

The number of blank rows to show on the entry screen.

Example: 3

time_periodstring

The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

Example: default_weekly

expense_periodstring

The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

Example: default_weekly

custom_periodstring

The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

Example: default_weekly

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.

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_propertiesobject

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

create_timestampnumber<float>

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_isostring<date-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_propertiesobject

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

modify_timestampnumber<float>

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_isostring<date-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

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, or custom_fields.users_email.value.

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.

reserved2number<float>

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

reserved3number<float>

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.

id_requestor_properties object

The properties of the Requestor of the Requisition. This is only included if requested in $keys.

idstring

The internal ID of the resource or object. This is a 32-character hexadecimal string (UUID without hyphens).

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

Example: 64BBA147B9AC41D9978062300826C89F

uristring<uri-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

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

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

group_names object[]

A list of Groups (names and IDs) that the object belongs to.

This is a read-only list. To change the Groups that an object belongs to, use the groups field.

See GroupFields for additional information about Groups and this field.

Array [

idstring

The Group ID (32-character hexadecimal string).

pnamestring

The Group name.

uristring

The URI of the Group.

WARNING: this field is planned in a future release but is not yet available.

]

groupsstring[]

A list of Group IDs that the object belongs to. See GroupFields for additional information about Groups and this field.

Example: ["5088C427E8B64EBEBE1C5B5961DB1902","3553F715A6F54DAB95D0D25B08468195"]

is_hiddenboolean

Indicates whether the object is hidden.

See also status

hiddenboolean

Indicates whether the user is hidden.

Read-only alias for is_hidden.

statusstring

The status of the user; either hidden, active, or inactive.

Possible values: [Hidden, Loggable and Reportable, Reportable Only]

Example: Loggable and Reportable

status_codestring

The internal code for the status of the object; either:

• lr for Loggable and Reportable
• ro for Reportable Only
• h for Hidden

Possible values: [lr, ro, h]

Example: lr

user_loginstringrequired

The login name of the user.

Example: john.smith@example.com

fullnamestringrequired

The full name of the user.

Example: John Smith

u_commentstring

The default comment on the user's time entry screen.

default_memorized_sheetstring

The ID of the user's default memorized timesheet.

dropdownthresholdinteger

The number of items in a selection list to trigger a forced search.

hideboolean

Indicates whether the user is hidden.

Note: the User object is the only one that uses this field; other objects use is_hidden.

expire_new_pwboolean

Whether the user's new password should expire after the first login.

This is a write-only field that does not appear in User object responses.

new_pwstring

The new password for the user.

The password must also be set in the new_pw2 field to confirm the change.

This is a write-only field that does not appear in User object responses.

new_pw2string

The new password for the user, repeated to confirm the change.

The password must also be set in the new_pw field to confirm the change.

This is a write-only field that does not appear in User object responses.

rolesstring[]

A list of role IDs belonging to this user.

This list can be modified to change the user's roles.

timerecs_ininteger

The number of blank rows to show on the entry screen.

Example: 3

time_periodstring

The "Entry Screen period" (time-span) associated with the user's Time Entry screen.

Example: default_weekly

expense_periodstring

The "Entry Screen period" (time-span) associated with the user's Expense Entry screen.

Example: default_weekly

custom_periodstring

The "Entry Screen period" (time-span) associated with the user's Custom Entry screen.

Example: default_weekly

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.

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_propertiesobject

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

create_timestampnumber<float>

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_isostring<date-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_propertiesobject

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

modify_timestampnumber<float>

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_isostring<date-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

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, or custom_fields.users_email.value.

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.

reserved2number<float>

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

reserved3number<float>

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.

project_pnamestring

The name of the Project that the Requisition is associated with.

Example: Project XYZ

requestee_fullnamestring

The full name of the Requestee of the Requisition.

requestor_fullnamestring

The full name of the Requestor of the Requisition.

Requisition

{
  "id_requisition": "150B0C860670432E82D39F14F98DD2F3",
  "pname": "Task XYZ",
  "assignment_pname": "Task XYZ",
  "description": "Requisition for Task XYZ",
  "history_url": "notes.pyc?viewnote=F6668AA582574475A6FE5D1CC501F795&bday=19710101&eday=20131214",
  "id_assignment_properties": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "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"
      }
    },
    "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,
    "creator": "64BBA147B9AC41D9978062300826C89F",
    "creator_fullname": "John Doe",
    "creator_properties": {
      "id": "64BBA147B9AC41D9978062300826C89F",
      "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
      "tablename": "users",
      "table_label": "codes_pay_types",
      "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"
        }
      },
      "group_names": [
        {
          "id": "5088C427E8B64EBEBE1C5B5961DB1902",
          "pname": "Sales"
        },
        {
          "id": "3553F715A6F54DAB95D0D25B08468195",
          "pname": "Accounting"
        },
        {
          "id": "5088C427E8B64EBEBE1C5B5961DB1902",
          "pname": "Sales"
        },
        {
          "id": "3553F715A6F54DAB95D0D25B08468195",
          "pname": "Accounting"
        }
      ],
      "groups": [
        "5088C427E8B64EBEBE1C5B5961DB1902",
        "3553F715A6F54DAB95D0D25B08468195",
        "5088C427E8B64EBEBE1C5B5961DB1902",
        "3553F715A6F54DAB95D0D25B08468195"
      ],
      "is_hidden": true,
      "hidden": true,
      "status": "Loggable and Reportable",
      "status_code": "lr",
      "user_login": "john.smith@example.com",
      "fullname": "John Smith",
      "u_comment": "string",
      "default_memorized_sheet": "string",
      "dropdownthreshold": 0,
      "hide": true,
      "expire_new_pw": true,
      "new_pw": "string",
      "new_pw2": "string",
      "roles": [
        "string"
      ],
      "timerecs_in": 3,
      "time_period": "default_weekly",
      "expense_period": "default_weekly",
      "custom_period": "default_weekly",
      "expense_gui": "string",
      "time_gui": "string",
      "travel_gui": "string",
      "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": {},
      "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",
      "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": {
      "id": "64BBA147B9AC41D9978062300826C89F",
      "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
      "tablename": "users",
      "table_label": "codes_pay_types",
      "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"
        }
      },
      "group_names": [
        {
          "id": "5088C427E8B64EBEBE1C5B5961DB1902",
          "pname": "Sales"
        },
        {
          "id": "3553F715A6F54DAB95D0D25B08468195",
          "pname": "Accounting"
        },
        {
          "id": "5088C427E8B64EBEBE1C5B5961DB1902",
          "pname": "Sales"
        },
        {
          "id": "3553F715A6F54DAB95D0D25B08468195",
          "pname": "Accounting"
        }
      ],
      "groups": [
        "5088C427E8B64EBEBE1C5B5961DB1902",
        "3553F715A6F54DAB95D0D25B08468195",
        "5088C427E8B64EBEBE1C5B5961DB1902",
        "3553F715A6F54DAB95D0D25B08468195"
      ],
      "is_hidden": true,
      "hidden": true,
      "status": "Loggable and Reportable",
      "status_code": "lr",
      "user_login": "john.smith@example.com",
      "fullname": "John Smith",
      "u_comment": "string",
      "default_memorized_sheet": "string",
      "dropdownthreshold": 0,
      "hide": true,
      "expire_new_pw": true,
      "new_pw": "string",
      "new_pw2": "string",
      "roles": [
        "string"
      ],
      "timerecs_in": 3,
      "time_period": "default_weekly",
      "expense_period": "default_weekly",
      "custom_period": "default_weekly",
      "expense_gui": "string",
      "time_gui": "string",
      "travel_gui": "string",
      "creator": "64BBA147B9AC41D9978062300826C89F",
      "creator_fullname": "John Doe",
      "creator_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",
      "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",
      "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",
    "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_project_properties": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "is_hidden": true,
    "hidden": true,
    "status": "Loggable and Reportable",
    "status_code": "lr",
    "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"
      }
    },
    "group_names": [
      {
        "id": "5088C427E8B64EBEBE1C5B5961DB1902",
        "pname": "Sales"
      },
      {
        "id": "3553F715A6F54DAB95D0D25B08468195",
        "pname": "Accounting"
      },
      {
        "id": "5088C427E8B64EBEBE1C5B5961DB1902",
        "pname": "Sales"
      },
      {
        "id": "3553F715A6F54DAB95D0D25B08468195",
        "pname": "Accounting"
      }
    ],
    "groups": [
      "5088C427E8B64EBEBE1C5B5961DB1902",
      "3553F715A6F54DAB95D0D25B08468195",
      "5088C427E8B64EBEBE1C5B5961DB1902",
      "3553F715A6F54DAB95D0D25B08468195"
    ],
    "id_parent": "64BBA147B9AC41D9978062300826C89F",
    "pname": "XYZ Project",
    "description": "This is a description of the XYZ Project.",
    "hours_estimate": 100,
    "percent_complete": 50,
    "project_type": 1,
    "wbs": null,
    "id_owner": "64BBA147B9AC41D9978062300826C89F",
    "id_backup": "64BBA147B9AC41D9978062300826C89F",
    "rm_type": 0,
    "state": 0,
    "work_variance": 0,
    "start_variance": 0,
    "end_variance": 0,
    "duration_variance": 0,
    "scheduled_work": 0,
    "scheduled_start": 1727724343,
    "scheduled_end": 1727724343,
    "scheduled_duration": 10,
    "projected_cost": 1000,
    "projected_return": 2000,
    "projected_profit": 1000,
    "projected_roi": 2,
    "awaiting_export": 0,
    "allow_time": true,
    "allow_expense": true,
    "allow_custom": true,
    "allow_leave": true,
    "allow_holiday": true,
    "propagate_pa_rates": true,
    "multiple_assns": true,
    "agile_team_assns": true,
    "dependencies_new_children_inherit": true,
    "dependencies_copy_to_descendents": true,
    "dependencies": {
      "codes_pay_types": [
        "PayTypeID1",
        "PayTypeID2",
        "PayTypeID1",
        "PayTypeID2"
      ],
      "codes_bill_types": [
        "BillTypeID1",
        "BillTypeID2",
        "BillTypeID1",
        "BillTypeID2"
      ]
    },
    "change_requests": [
      null
    ],
    "autoadd": false,
    "creator": "64BBA147B9AC41D9978062300826C89F",
    "creator_fullname": "John Doe",
    "creator_properties": {
      "id": "64BBA147B9AC41D9978062300826C89F",
      "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
      "tablename": "users",
      "table_label": "codes_pay_types",
      "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"
        }
      },
      "group_names": [
        {
          "id": "5088C427E8B64EBEBE1C5B5961DB1902",
          "pname": "Sales"
        },
        {
          "id": "3553F715A6F54DAB95D0D25B08468195",
          "pname": "Accounting"
        },
        {
          "id": "5088C427E8B64EBEBE1C5B5961DB1902",
          "pname": "Sales"
        },
        {
          "id": "3553F715A6F54DAB95D0D25B08468195",
          "pname": "Accounting"
        }
      ],
      "groups": [
        "5088C427E8B64EBEBE1C5B5961DB1902",
        "3553F715A6F54DAB95D0D25B08468195",
        "5088C427E8B64EBEBE1C5B5961DB1902",
        "3553F715A6F54DAB95D0D25B08468195"
      ],
      "is_hidden": true,
      "hidden": true,
      "status": "Loggable and Reportable",
      "status_code": "lr",
      "user_login": "john.smith@example.com",
      "fullname": "John Smith",
      "u_comment": "string",
      "default_memorized_sheet": "string",
      "dropdownthreshold": 0,
      "hide": true,
      "expire_new_pw": true,
      "new_pw": "string",
      "new_pw2": "string",
      "roles": [
        "string"
      ],
      "timerecs_in": 3,
      "time_period": "default_weekly",
      "expense_period": "default_weekly",
      "custom_period": "default_weekly",
      "expense_gui": "string",
      "time_gui": "string",
      "travel_gui": "string",
      "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": {},
      "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",
      "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": {
      "id": "64BBA147B9AC41D9978062300826C89F",
      "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
      "tablename": "users",
      "table_label": "codes_pay_types",
      "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"
        }
      },
      "group_names": [
        {
          "id": "5088C427E8B64EBEBE1C5B5961DB1902",
          "pname": "Sales"
        },
        {
          "id": "3553F715A6F54DAB95D0D25B08468195",
          "pname": "Accounting"
        },
        {
          "id": "5088C427E8B64EBEBE1C5B5961DB1902",
          "pname": "Sales"
        },
        {
          "id": "3553F715A6F54DAB95D0D25B08468195",
          "pname": "Accounting"
        }
      ],
      "groups": [
        "5088C427E8B64EBEBE1C5B5961DB1902",
        "3553F715A6F54DAB95D0D25B08468195",
        "5088C427E8B64EBEBE1C5B5961DB1902",
        "3553F715A6F54DAB95D0D25B08468195"
      ],
      "is_hidden": true,
      "hidden": true,
      "status": "Loggable and Reportable",
      "status_code": "lr",
      "user_login": "john.smith@example.com",
      "fullname": "John Smith",
      "u_comment": "string",
      "default_memorized_sheet": "string",
      "dropdownthreshold": 0,
      "hide": true,
      "expire_new_pw": true,
      "new_pw": "string",
      "new_pw2": "string",
      "roles": [
        "string"
      ],
      "timerecs_in": 3,
      "time_period": "default_weekly",
      "expense_period": "default_weekly",
      "custom_period": "default_weekly",
      "expense_gui": "string",
      "time_gui": "string",
      "travel_gui": "string",
      "creator": "64BBA147B9AC41D9978062300826C89F",
      "creator_fullname": "John Doe",
      "creator_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",
      "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",
      "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_requestee_properties": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "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"
      }
    },
    "group_names": [
      {
        "id": "5088C427E8B64EBEBE1C5B5961DB1902",
        "pname": "Sales"
      },
      {
        "id": "3553F715A6F54DAB95D0D25B08468195",
        "pname": "Accounting"
      },
      {
        "id": "5088C427E8B64EBEBE1C5B5961DB1902",
        "pname": "Sales"
      },
      {
        "id": "3553F715A6F54DAB95D0D25B08468195",
        "pname": "Accounting"
      }
    ],
    "groups": [
      "5088C427E8B64EBEBE1C5B5961DB1902",
      "3553F715A6F54DAB95D0D25B08468195",
      "5088C427E8B64EBEBE1C5B5961DB1902",
      "3553F715A6F54DAB95D0D25B08468195"
    ],
    "is_hidden": true,
    "hidden": true,
    "status": "Loggable and Reportable",
    "status_code": "lr",
    "user_login": "john.smith@example.com",
    "fullname": "John Smith",
    "u_comment": "string",
    "default_memorized_sheet": "string",
    "dropdownthreshold": 0,
    "hide": true,
    "expire_new_pw": true,
    "new_pw": "string",
    "new_pw2": "string",
    "roles": [
      "string"
    ],
    "timerecs_in": 3,
    "time_period": "default_weekly",
    "expense_period": "default_weekly",
    "custom_period": "default_weekly",
    "expense_gui": "string",
    "time_gui": "string",
    "travel_gui": "string",
    "creator": "64BBA147B9AC41D9978062300826C89F",
    "creator_fullname": "John Doe",
    "creator_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": {},
    "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",
    "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": {}
  },
  "id_requestor_properties": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "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"
      }
    },
    "group_names": [
      {
        "id": "5088C427E8B64EBEBE1C5B5961DB1902",
        "pname": "Sales"
      },
      {
        "id": "3553F715A6F54DAB95D0D25B08468195",
        "pname": "Accounting"
      },
      {
        "id": "5088C427E8B64EBEBE1C5B5961DB1902",
        "pname": "Sales"
      },
      {
        "id": "3553F715A6F54DAB95D0D25B08468195",
        "pname": "Accounting"
      }
    ],
    "groups": [
      "5088C427E8B64EBEBE1C5B5961DB1902",
      "3553F715A6F54DAB95D0D25B08468195",
      "5088C427E8B64EBEBE1C5B5961DB1902",
      "3553F715A6F54DAB95D0D25B08468195"
    ],
    "is_hidden": true,
    "hidden": true,
    "status": "Loggable and Reportable",
    "status_code": "lr",
    "user_login": "john.smith@example.com",
    "fullname": "John Smith",
    "u_comment": "string",
    "default_memorized_sheet": "string",
    "dropdownthreshold": 0,
    "hide": true,
    "expire_new_pw": true,
    "new_pw": "string",
    "new_pw2": "string",
    "roles": [
      "string"
    ],
    "timerecs_in": 3,
    "time_period": "default_weekly",
    "expense_period": "default_weekly",
    "custom_period": "default_weekly",
    "expense_gui": "string",
    "time_gui": "string",
    "travel_gui": "string",
    "creator": "64BBA147B9AC41D9978062300826C89F",
    "creator_fullname": "John Doe",
    "creator_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": {},
    "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",
    "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": {}
  },
  "project_pname": "Project XYZ",
  "requestee_fullname": "string",
  "requestor_fullname": "string",
  "id": "64BBA147B9AC41D9978062300826C89F",
  "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
  "tablename": "users",
  "table_label": "codes_pay_types",
  "id_project": "20945205C94E4576B5FB798DA09B44DE",
  "id_requestee": "64BBA147B9AC41D9978062300826C89F",
  "id_requestor": "64BBA147B9AC41D9978062300826C89F",
  "request_date": 1681776000,
  "response_date": 1681796000,
  "state": "open",
  "comment": "string",
  "notify_requestee": true,
  "notify_requestor": true,
  "id_assignment": "string",
  "scheduled_end": 1679616000,
  "scheduled_start": 1678060800,
  "scheduled_work": 40,
  "creator": "64BBA147B9AC41D9978062300826C89F",
  "creator_fullname": "John Doe",
  "creator_properties": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "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"
      }
    },
    "group_names": [
      {
        "id": "5088C427E8B64EBEBE1C5B5961DB1902",
        "pname": "Sales"
      },
      {
        "id": "3553F715A6F54DAB95D0D25B08468195",
        "pname": "Accounting"
      }
    ],
    "groups": [
      "5088C427E8B64EBEBE1C5B5961DB1902",
      "3553F715A6F54DAB95D0D25B08468195"
    ],
    "is_hidden": true,
    "hidden": true,
    "status": "Loggable and Reportable",
    "status_code": "lr",
    "user_login": "john.smith@example.com",
    "fullname": "John Smith",
    "u_comment": "string",
    "default_memorized_sheet": "string",
    "dropdownthreshold": 0,
    "hide": true,
    "expire_new_pw": true,
    "new_pw": "string",
    "new_pw2": "string",
    "roles": [
      "string"
    ],
    "timerecs_in": 3,
    "time_period": "default_weekly",
    "expense_period": "default_weekly",
    "custom_period": "default_weekly",
    "expense_gui": "string",
    "time_gui": "string",
    "travel_gui": "string",
    "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": {},
    "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",
    "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": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "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"
      }
    },
    "group_names": [
      {
        "id": "5088C427E8B64EBEBE1C5B5961DB1902",
        "pname": "Sales"
      },
      {
        "id": "3553F715A6F54DAB95D0D25B08468195",
        "pname": "Accounting"
      }
    ],
    "groups": [
      "5088C427E8B64EBEBE1C5B5961DB1902",
      "3553F715A6F54DAB95D0D25B08468195"
    ],
    "is_hidden": true,
    "hidden": true,
    "status": "Loggable and Reportable",
    "status_code": "lr",
    "user_login": "john.smith@example.com",
    "fullname": "John Smith",
    "u_comment": "string",
    "default_memorized_sheet": "string",
    "dropdownthreshold": 0,
    "hide": true,
    "expire_new_pw": true,
    "new_pw": "string",
    "new_pw2": "string",
    "roles": [
      "string"
    ],
    "timerecs_in": 3,
    "time_period": "default_weekly",
    "expense_period": "default_weekly",
    "custom_period": "default_weekly",
    "expense_gui": "string",
    "time_gui": "string",
    "travel_gui": "string",
    "creator": "64BBA147B9AC41D9978062300826C89F",
    "creator_fullname": "John Doe",
    "creator_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",
    "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",
    "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"
}