Jump to

• Request
• Response

Read Users

get

/user

Reads User objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter(required): string
  Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:

  Example:

  ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'

• OrderBy(required): string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<User>

Type: array

Title: List<User>

Show Source

• Array of: object User
  Title: User

  User Entity

{
    "title":"List<User>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/User"
    }
}

Nested Schema : User

Type: object

Title: User

User Entity

Show Source

• AllResourceAccessFlag: boolean
  The flag that determines whether the user has all resource access (TRUE) or restricted resource access (FALSE). Admin Superusers always have all resource access.
• AssignmentStaffingPreference: string
  The value that determines whether the current or the new resource's Units per Time and Overtime factor is used to calculate costs when assigning the resource to an existing activity assignment. If the AssignmentStaffingPreference is set to 'Ask Me', the default value is then current resource.
• CreateDate: string (date-time)
  The date this user was created.
• CreateUser: string
  The name of the user that created this user.
• CurrencyId: string
  The unique currency abbreviation for the currency associated with this user.
• CurrencyName: string
  The name of the currency associated with this user.
• CurrencyObjectId: integer (int32)
  The unique ID of the associated currency.
• CurrencyShowDecimals: boolean
  The flag which when set to true will show decimal places for the currency, and when set to false will not Display decimal places. Possible values : 'True' or 'False'
• CurrencyShowSymbol: boolean
  The flag which when set to true will show Currency Symbol for the currency, and when set to false will not Display Currency Symbol. Possible values : 'True' or 'False'
• DateFormatType: string
  The date format type for the user: 'Month, Day, Year' , 'Day, Month, Year' or 'Year, Month, Day'.
• DateSeparator: string
  The date Separator for the user: '/' , '-' or '.'
• DateShowFourDigitYear: boolean
  The flag which when set to true will show four digit year for the Date format specified, and when set to false will not show four digit year. Possible values : 'True' or 'False'
• DateShowMinutes: boolean
  The flag which when set to true will show minutes value for the Time format specified, and when set to false will not show minutes value. Possible values : 'True' or 'False'
• DateTimeFormatType: string
  The date format type for the user: '12 hour (1:30 PM)' , '24 hour (13:30)' or 'Do not show time'.
• DateUseLeadingZero: boolean
  The flag which when set to true will show leading zero for the Date format specified, and when set to false will not show leading zero. Possible values : 'True' or 'False'
• DateUseMonthName: boolean
  The flag which when set to true will show month value for the Date format specified, and when set to false will not show month value. Possible values : 'True' or 'False'
• DurationDecimalCount: string
  The Duration Decimal count for the user is the number of decimal places to be displayed for the Duration. : '0','1' or '2'.
• DurationUnitType: string
  The Duration Unit Type for the user is the Display Time units In: 'Hour','Day','Week','Month' or 'Year'.
• DurationUseFraction: boolean
  The flag which when set to true will show units for the Duration, and when set to false will not show units. Possible values : 'True' or 'False'
• EmailAddress: string
  The current user's return email address. This will be used in the "FROM" line for any email sent by this user. Example: "[e-mail]". For MAPI users, this may just be the MAPI profile name or mailbox name.
• EmailProtocol: string
  The email type for the user: 'Internet Mail' or 'MAPI Mail'.
• EnableUserToModifyViewSettingsFlag: boolean
  The flag that when set to true allows the user to change his or her personal view settings in P6. When a user changes the user interface view settings, the changes do not affect the settings of other users assigned to the same view.
• FinancialPeriodEndObjectId: integer (int32)
  The unique ID generated by the system of the last financial period viewable in columns in Project Management.
• FinancialPeriodStartObjectId: integer (int32)
  The unique ID generated by the system of the first financial period viewable in columns in Project Management.
• GlobalProfileObjectId: integer (int32)
  The unique ID of the global security profile assigned to the user. See the GlobalProfile class for constants defining the fixed profiles of Admin Superuser and No Global Privileges.
• GUID: string
  The globally unique ID generated by the system.
• LastUpdateDate: string (date-time)
  The date this user was last updated.
• LastUpdateUser: string
  The name of the user that last updated this user.
• MailServerLoginName: string
  The mail login name (profile name) for the current user to send outgoing email. If the email protocol is MAPI, this field should contain the MAPI profile name
• Name: string
  The user's login name.
• NewProjectDurationType: string
  the default duration type assigned to new activities. Valid values are 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• OfficePhone: string
  The work phone number of the user.
• OutgoingMailServer: string
  The outgoing mail server (SMTP) address used to send outgoing email for this user. The address may be a host name or an IP address. This field is used only with the Internet email protocol, and is not required for MAPI.
• PersonalName: string
  The user's personal or actual name.
• RateSourcePreference: string
  The value that determines which price/unit will be used by default to calculate costs for the assignment when both a resource and role are assigned.
• ReportingFlag: boolean
  The flag that determines whether the user can access ODS database as a database user.
• ResourceRequests: object ResourceRequests
• RespectActivityDurationType: boolean
  the setting that indicates whether to recalculate the Duration, Units, or Units/Time for existing assignments based on the activity Duration Type (true) or to preserve the Duration, Units, or Units/Time for existing assignments (false) when adding or removing assignments on activities.
• RoleLimitDisplayOption: string
  The option for how RoleLimit is displayed. Valid values are 'Custom', and 'PrimaryRole'.
• ShowDurationTimeUnit: boolean
  The flag which when set to true will show units for the Duration, and when set to false will not show units. Possible values : 'True' or 'False'
• ShowTimeUnit: boolean
  The flag which when set to true will show units for the Time, and when set to false will not show units. Possible values : 'True' or 'False'
• SmallScaleDecimalCount: string
  The Small Scale Decimal count for the user is the number of decimal places to be displayed for the Time. : '0','1' or '2'.
• SmallScaleUnitType: string
  The Small Scale Unit Type for the user is the Display Time units In: 'Hour','Day','Week','Month' or 'Year'.
• SmallScaleUseFraction: boolean
  The flag which when set to true will show sub units for the Time units format specified, and when set to false will not show sub units. Possible values : 'True' or 'False'
• TeamMemberActivityFilters: string
  The Statuser activity filters for the Team Member application.
• TeamMemberActivitySortField: string
  Select whether column name entries are sorted in ascending or descending order.
• TeamMemberActivitySortOrder: string
  From the Sort Order list, you can select to list projects in the scorecard in either ascending
• TeamMemberApplicationTheme: string
  The user interface theme setting for P6 Team Member Web.
• TeamMemberDateFormat: string
  The date format setting for the P6 Team Member Web.
• TeamMemberDisplayQRQuickAccess: string
  The flag that is used to to determine if a user has seen the QR quick access link in P6 Team Member Web.
• TeamMemberDisplayTimeFlag: boolean
  The display hours setting for P6 Team Member Web.
• TeamMemberDisplayTimeFormat: string
  The display hours format setting for P6 Team Member Web.
• TeamMemberLocale: string
  The user-specific locale set for P6 Team Member Web.
• TeamMemberProjectFilter: string
  The project filter for P6 Team Member Web.
• TeamMemberResourceFilter: string
  The user-specific resource filter for P6 Team Member Web.
• TeamMemberTaskStatusFilter: string
  The task status filter for P6 Team Member Web.
• TeamMemberTimeframeFilter: string
• TeamMemberWBSFilter: string
  The time frame filter for P6 Team Member Web.
• TeamMemberWorkUnitType: string
  The user-specific wbs filter for P6 Team Member Web.
• UnitsPerTimeShowAsPercentage: boolean
  The flag which when set to true will show Units/Time as Percentage, and when set to false will display as Units/Duration. Possible values : 'True' or 'False'
• UserInterfaceViewObjectId: integer (int32)
  The unique ID of the associated user interface view.

{
    "title":"User",
    "type":"object",
    "properties":{
        "AllResourceAccessFlag":{
            "type":"boolean",
            "description":"The flag that determines whether the user has all resource access (TRUE) or restricted resource access (FALSE). Admin Superusers always have all resource access."
        },
        "AssignmentStaffingPreference":{
            "type":"string",
            "description":"The value that determines whether the current or the new resource's Units per Time and Overtime factor is used to calculate costs when assigning the resource to an existing activity assignment. If the AssignmentStaffingPreference is set to 'Ask Me', the default value is then current resource."
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this user was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this user."
        },
        "CurrencyId":{
            "type":"string",
            "description":"The unique currency abbreviation for the currency associated with this user."
        },
        "CurrencyName":{
            "type":"string",
            "description":"The name of the currency associated with this user."
        },
        "CurrencyObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated currency.",
            "format":"int32"
        },
        "CurrencyShowDecimals":{
            "type":"boolean",
            "description":"The flag which when set to true will show decimal places for the currency, and when set to false will not Display decimal places. Possible values : 'True' or 'False'"
        },
        "CurrencyShowSymbol":{
            "type":"boolean",
            "description":"The flag which when set to true will show Currency Symbol for the currency, and when set to false will not Display Currency Symbol. Possible values : 'True' or 'False'"
        },
        "DateFormatType":{
            "type":"string",
            "description":"The date format type for the user: 'Month, Day, Year' , 'Day, Month, Year' or 'Year, Month, Day'."
        },
        "DateSeparator":{
            "type":"string",
            "description":"The date Separator for the user: '/' , '-' or '.'"
        },
        "DateShowFourDigitYear":{
            "type":"boolean",
            "description":"The flag which when set to true will show four digit year for the Date format specified, and when set to false will not show four digit year. Possible values : 'True' or 'False'"
        },
        "DateShowMinutes":{
            "type":"boolean",
            "description":"The flag which when set to true will show minutes value for the Time format specified, and when set to false will not show minutes value. Possible values : 'True' or 'False'"
        },
        "DateTimeFormatType":{
            "type":"string",
            "description":"The date format type for the user: '12 hour (1:30 PM)' , '24 hour (13:30)' or 'Do not show time'."
        },
        "DateUseLeadingZero":{
            "type":"boolean",
            "description":"The flag which when set to true will show leading zero for the Date format specified, and when set to false will not show leading zero. Possible values : 'True' or 'False'"
        },
        "DateUseMonthName":{
            "type":"boolean",
            "description":"The flag which when set to true will show month value for the Date format specified, and when set to false will not show month value. Possible values : 'True' or 'False'"
        },
        "DurationDecimalCount":{
            "type":"string",
            "description":"The Duration Decimal count for the user is the number of decimal places to be displayed for the Duration. : '0','1' or '2'."
        },
        "DurationUnitType":{
            "type":"string",
            "description":"The Duration Unit Type for the user is the Display Time units In: 'Hour','Day','Week','Month' or 'Year'."
        },
        "DurationUseFraction":{
            "type":"boolean",
            "description":"The flag which when set to true will show units for the Duration, and when set to false will not show units. Possible values : 'True' or 'False'"
        },
        "EmailAddress":{
            "type":"string",
            "description":"The current user's return email address. This will be used in the \"FROM\" line for any email sent by this user. Example: \"[e-mail]\". For MAPI users, this may just be the MAPI profile name or mailbox name."
        },
        "EmailProtocol":{
            "type":"string",
            "description":"The email type for the user: 'Internet Mail' or 'MAPI Mail'."
        },
        "EnableUserToModifyViewSettingsFlag":{
            "type":"boolean",
            "description":"The flag that when set to true allows the user to change his or her personal view settings in P6. When a user changes the user interface view settings, the changes do not affect the settings of other users assigned to the same view."
        },
        "FinancialPeriodEndObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system of the last financial period viewable in columns in Project Management.",
            "format":"int32"
        },
        "FinancialPeriodStartObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system of the first financial period viewable in columns in Project Management.",
            "format":"int32"
        },
        "GUID":{
            "type":"string",
            "description":"The globally unique ID generated by the system."
        },
        "GlobalProfileObjectId":{
            "type":"integer",
            "description":"The unique ID of the global security profile assigned to the user. See the GlobalProfile class for constants defining the fixed profiles of Admin Superuser and No Global Privileges.",
            "format":"int32"
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this user was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this user."
        },
        "MailServerLoginName":{
            "type":"string",
            "description":"The mail login name (profile name) for the current user to send outgoing email. If the email protocol is MAPI, this field should contain the MAPI profile name"
        },
        "Name":{
            "type":"string",
            "description":"The user's login name."
        },
        "NewProjectDurationType":{
            "type":"string",
            "description":"the default duration type assigned to new activities. Valid values are 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "OfficePhone":{
            "type":"string",
            "description":"The work phone number of the user."
        },
        "OutgoingMailServer":{
            "type":"string",
            "description":"The outgoing mail server (SMTP) address used to send outgoing email for this user. The address may be a host name or an IP address. This field is used only with the Internet email protocol, and is not required for MAPI."
        },
        "PersonalName":{
            "type":"string",
            "description":"The user's personal or actual name."
        },
        "RateSourcePreference":{
            "type":"string",
            "description":"The value that determines which price/unit will be used by default to calculate costs for the assignment when both a resource and role are assigned."
        },
        "ReportingFlag":{
            "type":"boolean",
            "description":"The flag that determines whether the user can access ODS database as a database user."
        },
        "ResourceRequests":{
            "$ref":"#/components/schemas/ResourceRequests"
        },
        "RespectActivityDurationType":{
            "type":"boolean",
            "description":"the setting that indicates whether to recalculate the Duration, Units, or Units/Time for existing assignments based on the activity Duration Type (true) or to preserve the Duration, Units, or Units/Time for existing assignments (false) when adding or removing assignments on activities."
        },
        "RoleLimitDisplayOption":{
            "type":"string",
            "description":"The option for how RoleLimit is displayed. Valid values are 'Custom', and 'PrimaryRole'."
        },
        "ShowDurationTimeUnit":{
            "type":"boolean",
            "description":"The flag which when set to true will show units for the Duration, and when set to false will not show units. Possible values : 'True' or 'False'"
        },
        "ShowTimeUnit":{
            "type":"boolean",
            "description":"The flag which when set to true will show units for the Time, and when set to false will not show units. Possible values : 'True' or 'False'"
        },
        "SmallScaleDecimalCount":{
            "type":"string",
            "description":"The Small Scale Decimal count for the user is the number of decimal places to be displayed for the Time. : '0','1' or '2'."
        },
        "SmallScaleUnitType":{
            "type":"string",
            "description":"The Small Scale Unit Type for the user is the Display Time units In: 'Hour','Day','Week','Month' or 'Year'."
        },
        "SmallScaleUseFraction":{
            "type":"boolean",
            "description":"The flag which when set to true will show sub units for the Time units format specified, and when set to false will not show sub units. Possible values : 'True' or 'False'"
        },
        "TeamMemberActivityFilters":{
            "type":"string",
            "description":"The Statuser activity filters for the Team Member application."
        },
        "TeamMemberActivitySortField":{
            "type":"string",
            "description":"Select whether column name entries are sorted in ascending or descending order."
        },
        "TeamMemberActivitySortOrder":{
            "type":"string",
            "description":"From the Sort Order list, you can select to list projects in the scorecard in either ascending"
        },
        "TeamMemberApplicationTheme":{
            "type":"string",
            "description":"The user interface theme setting for P6 Team Member Web."
        },
        "TeamMemberDateFormat":{
            "type":"string",
            "description":"The date format setting for the P6 Team Member Web."
        },
        "TeamMemberDisplayTimeFlag":{
            "type":"boolean",
            "description":"The display hours setting for P6 Team Member Web."
        },
        "TeamMemberDisplayTimeFormat":{
            "type":"string",
            "description":"The display hours format setting for P6 Team Member Web."
        },
        "TeamMemberLocale":{
            "type":"string",
            "description":"The user-specific locale set for P6 Team Member Web."
        },
        "TeamMemberProjectFilter":{
            "type":"string",
            "description":"The project filter for P6 Team Member Web."
        },
        "TeamMemberResourceFilter":{
            "type":"string",
            "description":"The user-specific resource filter for P6 Team Member Web."
        },
        "TeamMemberDisplayQRQuickAccess":{
            "type":"string",
            "description":"The flag that is used to to determine if a user has seen the QR quick access link in P6 Team Member Web."
        },
        "TeamMemberTaskStatusFilter":{
            "type":"string",
            "description":"The task status filter for P6 Team Member Web."
        },
        "TeamMemberTimeframeFilter":{
            "type":"string"
        },
        "TeamMemberWBSFilter":{
            "type":"string",
            "description":"The time frame filter for P6 Team Member Web."
        },
        "TeamMemberWorkUnitType":{
            "type":"string",
            "description":"The user-specific wbs filter for P6 Team Member Web."
        },
        "UnitsPerTimeShowAsPercentage":{
            "type":"boolean",
            "description":"The flag which when set to true will show Units/Time as Percentage, and when set to false will display as Units/Duration. Possible values : 'True' or 'False'"
        },
        "UserInterfaceViewObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated user interface view.",
            "format":"int32"
        }
    },
    "description":"User Entity"
}

Nested Schema : ResourceRequests

Type: object

Show Source

• ResourceRequest: array ResourceRequest

{
    "type":"object",
    "properties":{
        "ResourceRequest":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRequest"
            }
        }
    }
}

Nested Schema : ResourceRequest

Type: array

Show Source

• Array of: object ResourceRequest

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceRequest"
    }
}

Nested Schema : ResourceRequest

Type: object

Show Source

• FinishDate: string (date-time)
• MatchAllCriteria: boolean
• Name: string
• RequestedUnits: number (double)
• ResourceRequestCriterion: array ResourceRequestCriterion
• SequenceNumber: integer (int32)
• ShowOnlyLaborResources: boolean
• ShowOverallocatedResources: boolean
• SortResultsByAvailability: boolean
• StartDate: string (date-time)
• UseActivityDates: boolean

{
    "type":"object",
    "properties":{
        "FinishDate":{
            "type":"string",
            "format":"date-time"
        },
        "MatchAllCriteria":{
            "type":"boolean"
        },
        "Name":{
            "type":"string"
        },
        "RequestedUnits":{
            "type":"number",
            "format":"double"
        },
        "SequenceNumber":{
            "type":"integer",
            "format":"int32"
        },
        "ShowOnlyLaborResources":{
            "type":"boolean"
        },
        "ShowOverallocatedResources":{
            "type":"boolean"
        },
        "SortResultsByAvailability":{
            "type":"boolean"
        },
        "StartDate":{
            "type":"string",
            "format":"date-time"
        },
        "UseActivityDates":{
            "type":"boolean"
        },
        "ResourceRequestCriterion":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRequestCriterion"
            }
        }
    }
}

Nested Schema : ResourceRequestCriterion

Type: array

Show Source

• Array of: object ResourceRequestCriterion

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceRequestCriterion"
    }
}

Nested Schema : ResourceRequestCriterion

Type: object

Show Source

• CriterionType: string
• Proficiency: string
• ValueObjectId: integer (int32)

{
    "type":"object",
    "properties":{
        "CriterionType":{
            "type":"string"
        },
        "Proficiency":{
            "type":"string"
        },
        "ValueObjectId":{
            "type":"integer",
            "format":"int32"
        }
    }
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top