MyApprovalQueueResults

The response to a request for the current user's approval queue.

requireViewingboolean

Indicates whether the user must view the Entry Sheet before taking approval action on it.

canReopenSheetsboolean

Indicates whether the user can reopen Entry Sheets.

canShowFullSheetLinkboolean

Indicates whether to display a link to open the full sheet in a separate window.

canShowSheetHistoryboolean

Indicates whether to display a link to view the history of the Entry Sheet.

screen object

The current UI settings for the Approvals screen.

iduuid

The internal ID of the resource or object.

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

Example: 64BBA147B9AC41D9978062300826C89F

uriuri-reference

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

Example: /api/v1/objects/64BBA147B9AC41D9978062300826C89F

tablenamestring

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

Example: users

table_labelstring

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

Example: codes_pay_types

allow_customizeboolean

Whether the user is allowed to customize the settings for this screen.

Example: true

fields object[]

The fields that are available on this screen.

Array [

default_tooltipstring

The default tooltip for the field shown when hovering over the field label.

Example: The name of the Accrual.

idstring

The database ID for the instance of the configured field within the screen. This is a generated value (not fixed).

Example: 34

id_attr_typestring

If this field represents a Custom Field, this is the ID of the Custom Field Type.

Example: null

id_fieldstring

The hardcoded identifier for the field within the screen. These are unique within the screen, but not across different screens.

Example: id_user_properties.fullname

id_field_globalstring

The internal database ID for the configured field, if this is a global settings field.

Example: 34

id_screenstring

The unique identifier for the screen that this field belongs to.

Example: accruals

is_booleanboolean

Whether the field is a boolean field, which will be displayed as a "Yes" or "No" value in the column.

Example: false

is_custom_fieldboolean

Whether the field is a Custom Field.

Example: false

is_datetime_floatboolean

Whether the field is a date-time field, which will be displayed as a formatted date-time value in the column.

Example: false

is_numericboolean

Whether the field is a numeric field, which will be displayed as a formatted number in the column.

Example: false

is_percentboolean

Whether the field is a percentage field, which will be displayed as a formatted percentage value in the column.

Example: false

is_truncatedboolean

Whether the field is automatically truncated when displayed in the search results; the full value can be seen in the tooltip.

Example: false

is_urlboolean

Whether the field is a URL field, which will be displayed as a clickable link in the column.

Example: false

keystring

The key for the field, which is used to identify the field in the search results and in the API. Same as id_field.

Example: id_user_properties.fullname

labelstring

The label to show for this field in the management screen search results.

Example: Owner Name

orderinginteger

The order in which this field should be displayed in the search results.

Example: 1

properties object

Additional extended properties of the field.

property name*string

searchableboolean

Whether the field is searchable in the search panel area on the management screen.

Example: true

sortableboolean

Whether the field is sortable in the search results.

Example: true

table_labelstring

Label of the database table that stores field settings.

Example: Field Config (global)

tablenamestring

The name of the database table that stores the field settings.

Example: fields_config_global

tooltipstring

The tooltip to show for this field in the management screen search results.

Example: The full name of the owner of this Accrual.

]

creatorstring

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

Example: 64BBA147B9AC41D9978062300826C89F

creator_fullnamestring

The full name of the user who created the object.

Example: John Doe

creator_properties object

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

expense_guistring

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

time_guistring

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

travel_guistring

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

daysinlistinteger

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

emailstring

The email address of the user.

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

first_namestring

The first name of the user.

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

id_userstring

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

Example: 5CD906A3941C463B9CC98F49DBCC25AA

last_namestring

The last name of the user.

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

memorized_sheet_choices object[]

A list of memorized timesheets associated with the user.

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

Array [

valuestring

The internal ID of the memorized timesheet.

textstring

The name of the memorized timesheet.

]

reserved1string

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

reserved2float

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

reserved3float

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

timerecs_outinteger

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

time_gui_propertiesobject

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

travel_gui_propertiesobject

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

expense_gui_propertiesobject

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

create_timestampfloat

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

Example: 1696021987.01375

create_timestamp_date_longstring

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

Example: Wednesday, March 22, 2023

create_timestamp_date_shortstring

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

Example: 03/22/2023

create_timestamp_datetime_longstring

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

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

create_timestamp_datetime_shortstring

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

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

create_timestamp_isodate-time

The creation timestamp in ISO 8601 format.

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

modifierstring

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

Example: 64BBA147B9AC41D9978062300826C89F

modifier_fullnamestring

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

Example: John Doe

modifier_properties object

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

expense_guistring

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

time_guistring

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

travel_guistring

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

daysinlistinteger

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

emailstring

The email address of the user.

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

first_namestring

The first name of the user.

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

id_userstring

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

Example: 5CD906A3941C463B9CC98F49DBCC25AA

last_namestring

The last name of the user.

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

memorized_sheet_choices object[]

A list of memorized timesheets associated with the user.

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

Array [

valuestring

The internal ID of the memorized timesheet.

textstring

The name of the memorized timesheet.

]

reserved1string

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

reserved2float

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

reserved3float

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

timerecs_outinteger

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

time_gui_propertiesobject

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

travel_gui_propertiesobject

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

expense_gui_propertiesobject

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

modify_timestampfloat

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

Example: 1696021987.01375

modify_timestamp_date_longstring

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

Example: Wednesday, March 22, 2023

modify_timestamp_date_shortstring

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

Example: 03/22/2023

modify_timestamp_datetime_longstring

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

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

modify_timestamp_datetime_shortstring

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

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

modify_timestamp_isodate-time

The last modification timestamp in ISO 8601 format.

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

id_domainstring

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

Example: install_root_dom

id_screenstring

The unique internal ID of this screen. (Same as id.) These are fixed values that are defined in the system.

Example: accruals

propertiesobject

Additional properties of the screen. Currently this is not used.

queue object[]

The current user's approval queue. These are sheets (or Project Approval track within sheets) that require the user's approval.

Array [

amountnumber

The total amount (hours or currency) of the sheet.

Example: 40

attachments_countinteger

The number of attachments on the sheet.

Example: 2

create_timestampfloat

The timestamp when the object was created, in Unix epoch format.

Example: 1696021987.01375

creatorstring

The user ID who created the sheet. This is not necessarily the nominal owner of the sheet.

Example: 75B23EADB8BC4171AA052B37A297D29B

end_datedate

The end date of the sheet in YYYYMMDD format.

Example: 20231231

end_date_epochfloat

The end date of the sheet in Unix epoch format.

Example: 1696032000

end_date_isostring

The end date of the sheet in ISO 8601 format.

Example: 2023-12-31

end_date_longstring

The long-formatted end date of the sheet. The format is determined by the "Long Date" system setting.

Example: Saturday, September 30, 2023

end_date_shortstring

The short-formatted end date of the sheet. The format is determined by the "Short Date" system setting.

Example: 09/30/2023

history_note_countinteger

The number of history notes on the sheet.

Example: 3

history_urlstring

The URL to view the history of the sheet.

Example: /jtcgi/approveprojects.pyc?history=F554B5C8A0AC4982BFF6EBBF47E0FC86&nav_key=sheet_history

i_am_group_approverboolean

Indicates whether the user is a group approver for the sheet.

Example: true

id_approverstring

The user ID of the designated or next approver for the sheet.

Example: 75B23EADB8BC4171AA052B37A297D29B

id_approver_propertiesobject

The User properties of the designated or next approver for the sheet.

id_domainstring

The domain ID of the sheet.

Example: install_root_dom

id_sheetstring

The Entry Sheet ID. You will need to submit this ID to approve or reject the sheet.

Example: F554B5C8A0AC4982BFF6EBBF47E0FC86

id_timesheetstring

The Time Period ID of the Entry Sheet. This points to the definition of how many days the user's sheets should span.

id_userstring

The user ID of the sheet owner.

Example: F0C5C7F8DE3D48A2824AEE584F077E58

id_user_propertiesobject

The User properties of the sheet owner

is_approvedboolean

Indicates whether the sheet has been approved at any level. This doesn't necessarily indicate full approval at all approval levels.

Example: false

is_fully_approvedboolean

Indicates whether the sheet has been fully approved at all approval levels.

Example: false

is_fully_openboolean

Indicates whether the sheet has never been approved or rejected. A sheet is "fully open" if it's in the "Open" state and not the "Rejected". In both states, the sheet is editable by the user.

Example: true

is_openboolean

Indicates whether the sheet is open for editing. This includes both the "Open" and "Rejected" states.

Example: true

is_rejectedboolean

Indicates whether the sheet is currently in the rejected state. Note that if a sheet was once rejected, but then re-submitted for approval, it will not be considered in the "rejected" state.

Example: false

is_submittedboolean

Indicates whether the sheet is currently being submitted for approval. When it is in this state, no approvals or rejections have occurred.

Example: true

is_virtualboolean

Indicates whether the sheet is a virtual sheet. A virtual sheet is the submission of only a portion of a sheet for approval rather than the full sheet.

Example: false

levelinteger

The current approval level of the sheet. This is the level at which the sheet is currently being approved. A sheet at level 1 has been submitted to the first level of approvers.

modifierstring

The user ID who last modified the sheet.

Example: 75B23EADB8BC4171AA052B37A297D29B

modify_timestampfloat

The timestamp when the object was most recently modified, in Unix epoch format.

Example: 1696021987.01375

pnamestring

An auto-generated string which identifies the sheet's time period.

Example: 09/24/2023 - 09/30/2023

sheettypestring

The Sheet Type code. The value mileage is used for what the system calls "Custom Entry" sheets.

Possible values: [time, expense, mileage]

sheettype_labelstring

The human-readable label for the sheet type.

Example: Time

start_datedate

The start date of the sheet in YYYYMMDD format.

Example: 20231231

start_date_epochfloat

The start date of the sheet in Unix epoch format.

Example: 1696032000

start_date_isostring

The start date of the sheet in ISO 8601 format.

Example: 2023-12-31

start_date_longstring

The long-formatted start date of the sheet. The format is determined by the "Long Date" system setting.

Example: Saturday, September 30, 2023

start_date_shortstring

The short-formatted start date of the sheet. The format is determined by the "Short Date" system setting.

Example: 09/30/2023

stateinteger

The current state of the sheet using internal state codes.

• 0 - OPEN - "fully open" for entry
• 1 - SUBMITTED - submitted for approval
• 2 - APPROVED - approved
• 3 - REJECTED - rejected (but open for entry)

Possible values: [0, 1, 2, 3]

state_shortstring

The human-readable short-format label for the sheet state.

Example: Open

state_strstring

The human-readable label for the sheet state.

Example: Submitted to Jayne Smith for Approval

submitted_datedate

The submitted date of the sheet in YYYYMMDD format.

Example: 20231231

submitted_date_epochfloat

The submitted date of the sheet in Unix epoch format.

Example: 1696032000

submitted_date_isostring

The submitted date of the sheet in ISO 8601 format.

Example: 2023-12-31

submitted_date_longstring

The long-formatted submitted date of the sheet. The format is determined by the "Long Date" system setting.

Example: Saturday, September 30, 2023

submitted_date_shortstring

The short-formatted submitted date of the sheet. The format is determined by the "Short Date" system setting.

Example: 09/30/2023

]

MyApprovalQueueResults

{
  "requireViewing": true,
  "canReopenSheets": true,
  "canShowFullSheetLink": true,
  "canShowSheetHistory": true,
  "screen": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "allow_customize": true,
    "fields": [
      {
        "default_tooltip": "The name of the Accrual.",
        "id": "34",
        "id_attr_type": null,
        "id_field": "id_user_properties.fullname",
        "id_field_global": "34",
        "id_screen": "accruals",
        "is_boolean": false,
        "is_custom_field": false,
        "is_datetime_float": false,
        "is_numeric": false,
        "is_percent": false,
        "is_truncated": false,
        "is_url": false,
        "key": "id_user_properties.fullname",
        "label": "Owner Name",
        "ordering": 1,
        "properties": {},
        "searchable": true,
        "sortable": true,
        "table_label": "Field Config (global)",
        "tablename": "fields_config_global",
        "tooltip": "The full name of the owner of this Accrual."
      }
    ],
    "creator": "64BBA147B9AC41D9978062300826C89F",
    "creator_fullname": "John Doe",
    "creator_properties": {
      "expense_gui": "string",
      "time_gui": "string",
      "travel_gui": "string",
      "daysinlist": 0,
      "email": "string",
      "first_name": "string",
      "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
      "last_name": "string",
      "memorized_sheet_choices": [
        {
          "value": "string",
          "text": "string"
        }
      ],
      "reserved1": "string",
      "reserved2": 0,
      "reserved3": 0,
      "timerecs_out": 0,
      "time_gui_properties": {},
      "travel_gui_properties": {},
      "expense_gui_properties": {}
    },
    "create_timestamp": 1696021987.01375,
    "create_timestamp_date_long": "Wednesday, March 22, 2023",
    "create_timestamp_date_short": "03/22/2023",
    "create_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
    "create_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
    "create_timestamp_iso": "2023-03-22T12:18:46-05:00",
    "modifier": "64BBA147B9AC41D9978062300826C89F",
    "modifier_fullname": "John Doe",
    "modifier_properties": {
      "expense_gui": "string",
      "time_gui": "string",
      "travel_gui": "string",
      "daysinlist": 0,
      "email": "string",
      "first_name": "string",
      "id_user": "5CD906A3941C463B9CC98F49DBCC25AA",
      "last_name": "string",
      "memorized_sheet_choices": [
        {
          "value": "string",
          "text": "string"
        }
      ],
      "reserved1": "string",
      "reserved2": 0,
      "reserved3": 0,
      "timerecs_out": 0,
      "time_gui_properties": {},
      "travel_gui_properties": {},
      "expense_gui_properties": {}
    },
    "modify_timestamp": 1696021987.01375,
    "modify_timestamp_date_long": "Wednesday, March 22, 2023",
    "modify_timestamp_date_short": "03/22/2023",
    "modify_timestamp_datetime_long": "Wednesday, March 22, 2023 12:18:46 CDT",
    "modify_timestamp_datetime_short": "03/22/2023 12:18:46 CDT",
    "modify_timestamp_iso": "2023-03-22T12:18:46-05:00",
    "id_domain": "install_root_dom",
    "id_screen": "accruals",
    "properties": {}
  },
  "queue": [
    {
      "amount": 40,
      "attachments_count": 2,
      "create_timestamp": 1696021987.01375,
      "creator": "75B23EADB8BC4171AA052B37A297D29B",
      "end_date": "20231231",
      "end_date_epoch": 1696032000,
      "end_date_iso": "2023-12-31",
      "end_date_long": "Saturday, September 30, 2023",
      "end_date_short": "09/30/2023",
      "history_note_count": 3,
      "history_url": "/jtcgi/approveprojects.pyc?history=F554B5C8A0AC4982BFF6EBBF47E0FC86&nav_key=sheet_history",
      "i_am_group_approver": true,
      "id_approver": "75B23EADB8BC4171AA052B37A297D29B",
      "id_approver_properties": {},
      "id_domain": "install_root_dom",
      "id_sheet": "F554B5C8A0AC4982BFF6EBBF47E0FC86",
      "id_timesheet": "string",
      "id_user": "F0C5C7F8DE3D48A2824AEE584F077E58",
      "id_user_properties": {},
      "is_approved": false,
      "is_fully_approved": false,
      "is_fully_open": true,
      "is_open": true,
      "is_rejected": false,
      "is_submitted": true,
      "is_virtual": false,
      "level": 0,
      "modifier": "75B23EADB8BC4171AA052B37A297D29B",
      "modify_timestamp": 1696021987.01375,
      "pname": "09/24/2023 - 09/30/2023",
      "sheettype": "time",
      "sheettype_label": "Time",
      "start_date": "20231231",
      "start_date_epoch": 1696032000,
      "start_date_iso": "2023-12-31",
      "start_date_long": "Saturday, September 30, 2023",
      "start_date_short": "09/30/2023",
      "state": 0,
      "state_short": "Open",
      "state_str": "Submitted to Jayne Smith for Approval",
      "submitted_date": "20231231",
      "submitted_date_epoch": 1696032000,
      "submitted_date_iso": "2023-12-31",
      "submitted_date_long": "Saturday, September 30, 2023",
      "submitted_date_short": "09/30/2023"
    }
  ]
}