Get users

get

/rest/ofscCore/v1/users

This operation retrieves the list of users that are visible to the user sending the request.

The visibility rules are based on the user's association with the resource. If the user is assigned to the top level of the resource tree, then all the resources are visible and returned in the response. If the user is assigned to a lower level resource in the resource tree, then only the resources below the lower level resource are returned in the response.

Request

Query Parameters
  • The number of items to be returned in the response. The minimum value that can be specified is 1 and the maximum value that can be specified is 100. If the specified value is greater than 100, zero, or if no value is specified, then it defaults to 100.
  • The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : Users
Type: object
Title: Users
The collection of users.
Show Source
Nested Schema : Items
Type: array
Title: Items
An array of objects containing the user account details.
Show Source
Nested Schema : User
Type: object
Title: User
The details of the user account.
Show Source
  • Avatar
    Title: Avatar
    The profile picture of the user.
  • Title: Blocked Until Time
    The time until the account is blocked.
  • Title: Created Time
    The date and time when the user account is created.
  • Title: Date Format
    The date format of the user account.
  • Title: Language
    The preferred language of the user. This field accepts the language codes listed on: Supported Language Codes.
  • Title: Last Login Time
    The date and time when the user logged in to the account.
  • Title: Last Password Change Time
    The date and time when the password was changed.
  • Title: Last Updated Time
    The date and time when the user account was updated. This field is not updated if a custom property or the profile picture of the user is changed. This field is only updated when one of the built-in properties is changed.
  • Title: Login
    The unique identifier of the user account in Oracle Field Service Cloud.
  • Title: Login Attempts
    The number of unsuccessful login attempts.
  • Title: Long Date Format
    The long date format of the user account.
  • Title: Main Resource ID
    The unique identifier of the main resource of the user account. This field is only set for resources that represent field service personnel. It is not set for groups and routing buckets.

    This field is not returned in the response if empty strings are passed in the request.

  • Title: Name
    The full name of the user.
  • Title: Organizational Unit
    The identifier of the organization unit where the user works. The value of this field can be the ID of a resource with the role as 'bucket' or 'organization unit'.
  • Title: Temporary Password
    The temporary password of the user account. If the temporary password is set, then the user is prompted to change password on the next login.
  • Resources
    Title: Resources
    Minimum Number of Items: 1
    Unique Items Required: true
    The list of resources assigned to the user account. These resources along with their children are visible to the user. This list does not incIude the resources whose resource ID values are empty.
  • Title: Self Assignment
    Indicates whether the users can assign activities to themselves.
  • Title: Status
    Allowed Values: [ "active", "inactive" ]
    The status of the user account.
  • Title: Time Format
    The time format of the user account.
  • Title: Time Zone
    The name of the user's time zone.

    This field accepts both OFSC time zone names (for example, Eastern) and IANA standard time zone names (for example, America/New_York). It is recommended that IANA names are specified.

    For a list of supported time zones, see Supported Time Zones.

  • Title: Time Zone Diff
    The difference between UTC and the user's local time, displayed in minutes. For example, -180 means that the user's time is 3 hours behind UTC.

    This is a read-only field.

  • Title: Time Zone IANA Name
    The IANA name of the user's time zone (for example, America/New_York). For the list of IANA time zone names, see IANA Time Zones

    This is a read-only field and is only returned in responses.

  • Title: User Type
    The type of the user account. The access controls of the user account are defined based on the user type.
  • Title: Week Start
    Allowed Values: [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "default" ]
    The day on which the week starts for the user account.
Nested Schema : Avatar
Type: object
Title: Avatar
The profile picture of the user.
Show Source
Nested Schema : Resources
Type: array
Title: Resources
Minimum Number of Items: 1
Unique Items Required: true
The list of resources assigned to the user account. These resources along with their children are visible to the user. This list does not incIude the resources whose resource ID values are empty.
Show Source

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top

Examples

The following example shows how to get users by submitting a GET request on the REST resource.

Example of Request Header

The following shows an example of the request header.

GET /rest/ofscCore/v1/users/?limit=5&offset=2 HTTP/1.0
Authorization: Basic c29hcEBwZXRyb2xpYXNoZXZ5Y2gucmVzdDox
Host: etadev1f
Accept: */*

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx/1.6.3
Date: Wed, 16 Sep 2015 15:32:19 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "totalResults": 58,
    "limit": 5,
    "offset": 2,
    "items": [
        {
            "resources": [
                "22"
            ],
            "collaborationGroups": {
              "links": [
                {
                  "rel": "canonical",
                  "href": "https://etadev1f/rest/ofscCore/v1/users/manager/collaborationGroups"
                }
              ]
            },
            "name": "Manager",
            "status": "active",
            "login": "manager",
            "language": "en",
            "dateFormat": 12,
            "longDateFormat": 16,
            "timeFormat": 14,
            "weekStart": "default",
            "timeZoneDiff": -300,
            "timeZone": "Eastern",
            "createdTime": "2006-02-03 09:20:08",
            "lastUpdatedTime": "2013-08-27 13:05:08",
            "lastLoginTime": "2013-08-27 13:05:08",
            "lastPasswordChangeTime": "2012-07-18 17:23:00",
            "userType": "Manager",
            "inventories": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/inventories"
                    }
                ]
            },
            "users": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/users"
                    }
                ]
            },
            "serviceRequests": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/serviceRequests"
                    }
                ]
            },
            "workZones": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/workZones"
                    }
                ]
            },
            "workSkills": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/workSkills"
                    }
                ]
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://etadev1f/rest/ofscCore/v1/resources"
                },
                {
                    "rel": "describedby",
                    "href": "https://etadev1f/rest/ofscCore/v1/metadata-catalog/resources"
                }
            ]
        },
        {
            "resources": [
                "22"
            ],
            "collaborationGroups": {
              "links": [
                {
                  "rel": "canonical",
                  "href": "https://etadev1f/rest/ofscCore/v1/users/root/collaborationGroups"
                }
              ]
            },
            "name": "Administrator",
            "status": "inactive",
            "login": "root",
            "language": "en",
            "dateFormat": 12,
            "longDateFormat": 16,
            "timeFormat": 14,
            "weekStart": "default",
            "timeZoneDiff": -300,
            "timeZone": "Eastern",
            "createdTime": "2006-02-03 09:20:08",
            "lastUpdatedTime": "2013-04-11 13:54:47",
            "lastLoginTime": "2011-08-15 14:38:26",
            "lastPasswordChangeTime": "2006-04-27 15:48:15",
            "userType": "UT16_DISPLAY_PROFILE",
            "inventories": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/inventories"
                    }
                ]
            },
            "users": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/users"
                    }
                ]
            },
            "serviceRequests": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/serviceRequests"
                    }
                ]
            },
            "workZones": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/workZones"
                    }
                ]
            },
            "workSkills": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/workSkills"
                    }
                ]
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://etadev1f/rest/ofscCore/v1/resources"
                },
                {
                    "rel": "describedby",
                    "href": "https://etadev1f/rest/ofscCore/v1/metadata-catalog/resources"
                }
            ]
        },
        {
            "resources": [
                "routing"
            ],
            "collaborationGroups": {
              "links": [
                {
                  "rel": "canonical",
                  "href": "https://etadev1f/rest/ofscCore/v1/users/CSR/collaborationGroups"
                }
              ]
            },
            "name": "CSR",
            "status": "active",
            "login": "CSR",
            "language": "en",
            "dateFormat": 12,
            "longDateFormat": 16,
            "timeFormat": 14,
            "weekStart": "default",
            "timeZoneDiff": -300,
            "timeZone": "Eastern",
            "createdTime": "2006-08-16 09:56:21",
            "lastUpdatedTime": "2013-04-11 13:54:47",
            "lastLoginTime": "2012-07-03 11:49:03",
            "lastPasswordChangeTime": "2012-03-01 10:04:54",
            "userType": "CSR",
            "inventories": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/inventories"
                    }
                ]
            },
            "users": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/users"
                    }
                ]
            },
            "serviceRequests": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/serviceRequests"
                    }
                ]
            },
            "workZones": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/workZones"
                    }
                ]
            },
            "workSkills": {
                "links": [
                    {
                        "rel": "canonical",
                        "href": "https://etadev1f/rest/ofscCore/v1/resources/workSkills"
                    }
                ]
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://etadev1f/rest/ofscCore/v1/resources"
                },
                {
                    "rel": "describedby",
                    "href": "https://etadev1f/rest/ofscCore/v1/metadata-catalog/resources"
                }
            ]
        },
        ...
}            
}
Back to Top