Get signed in projects users

get

/fscmRestApi/resources/11.13.18.05/projectsUsers

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds all the projects users with the specified resource ID.
      Finder Variables:
      • ResourceId; integer; Finds all the projects users with the specified resource ID.
    • findByResourceId: Finds all the projects users with the specified resource ID.
      Finder Variables:
      • ResourceId; integer; Finds all the projects users with the specified resource ID.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • DisplayName; string; The name of the projects user.
    • Email; string; The email address of the projects user.
    • PersonId; integer; The unique identifier of the projects user in HCM.
    • Phone; string; The telephone number of the projects user.
    • ResourceId; integer; The unique identifier of the resource assigned to the task.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : projectsUsers
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : projectsUsers-item-response
Type: object
Show Source
Nested Schema : Chargeable Tasks
Type: array
Title: Chargeable Tasks
The tasks for which the projects user can report expenditures such as time.
Show Source
Nested Schema : Chargeable Projects
Type: array
Title: Chargeable Projects
The projects for which the projects user can report expenditures such as time.
Show Source
Nested Schema : Followed Project Tasks
Type: array
Title: Followed Project Tasks
The followed project task resource is used to retrieve attributes for a project task that a project user follows.
Show Source
Nested Schema : Followed To Do Tasks
Type: array
Title: Followed To Do Tasks
The followed to do task resource is used to retrieve attributes for a to do task that a project user follows. To do Tasks may be followed by many project users.
Show Source
Nested Schema : Project Tasks
Type: array
Title: Project Tasks
The project task resource is used to store values while creating or updating project tasks. A task is a unit of project work assigned or performed as part of a resource's duties. Tasks may be a portion of project work to be performed within a defined period by a specific resource or multiple resources.
Show Source
Nested Schema : To Do Tasks
Type: array
Title: To Do Tasks
The to do task resource is used to store values while creating or updating to do tasks. A to do task is a unit of work assigned or performed as part of a resource's duties outside of any project. To do tasks may be performed within a defined period by a specific resource.
Show Source
Nested Schema : projectsUsers-ChargeableFinancialTasks-item-response
Type: object
Show Source
Nested Schema : projectsUsers-ChargeableProjects-item-response
Type: object
Show Source
Nested Schema : projectsUsers-FollowedProjectTasks-item-response
Type: object
Show Source
Nested Schema : projectsUsers-FollowedToDoTasks-item-response
Type: object
Show Source
Nested Schema : projectsUsers-ProjectTasks-item-response
Type: object
Show Source
Nested Schema : Labor Resource Assignments
Type: array
Title: Labor Resource Assignments
The labor resource assignment includes attributes used to store values while creating or updating labor resource assignments for a project task. For example, a DBA may be assigned as a labor resource for a project task.
Show Source
Nested Schema : Project Task Followers
Type: array
Title: Project Task Followers
The task follower resource is used to store values while adding or removing followers on project tasks. A project user can be assigned as a follower on a project task for viewing task details and tracking its completion.
Show Source
Nested Schema : projectsUsers-ProjectTasks-LaborResourceAssignments-item-response
Type: object
Show Source
Nested Schema : projectsUsers-ProjectTasks-TaskFollowers-item-response
Type: object
Show Source
Nested Schema : projectsUsers-ToDoTasks-item-response
Type: object
Show Source
Nested Schema : To Do Task Followers
Type: array
Title: To Do Task Followers
The to do task follower resource is used to store values while adding or removing followers on to do tasks.
Show Source
Nested Schema : projectsUsers-ToDoTasks-ToDoTaskFollowers-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get signed in projects users by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X GET https://<host>:<port>/fscmRestApi/resources/latest/projectsUsers

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON forma:

{
  "items": [
    {
      "ResourceId": 300100024326655,
      "Phone": null,
      "Email": "prj_connor_horton_grp@oracle.com",
      "DisplayName": "Connor Horton",
      "links": [
        ...
		 "ResourceId": 300100024326688,
      "Phone": null,
      "Email": "prj_amy_horton_grp@oracle.com",
      "DisplayName": "Amy Horton",
      "links": [
        ...
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    ...
	  ]
			}
Back to Top