View all Resources by Parent Code
get
/api/restapi/resource/byParent
Send a request to this endpoint to view all resources under a parent with codes matching the code fields in the query parameters.
Request
Query Parameters
-
projectCode: string
The user-specified identifier of a project.
-
workspaceCode(required): string
Workspace code under which all the resources have to be found.
This is a required field.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityResource>
Type:
array
Title:
Show Source
List<ApiEntityResource>
-
Array of:
object ApiEntityResource
Title:
ApiEntityResource
Nested Schema : ApiEntityResource
Type:
object
Title:
Show Source
ApiEntityResource
-
addressLine1: string
Minimum Length:
0
Maximum Length:200
The first line of the address of a location.
This might be the building number and street address. -
addressLine2: string
Minimum Length:
0
Maximum Length:200
The second line of the address of a location.
This might be a neighborhood or town. -
applicationUserId: integer
(int64)
The name of the user in the application that is also a resource.
-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the resource and the workspace. Possible values are Owned and Inherited. -
calendar: integer
(int64)
The calendar assigned to the resource or role.
-
calendarCode: string
Minimum Length:
0
Maximum Length:255
The unique code for the calendar. -
calendarName: string
Minimum Length:
0
Maximum Length:255
The name of the calendar. -
cityName: string
Minimum Length:
0
Maximum Length:200
The city name for a location. -
codeValuesResource: array
codeValuesResource
The list of code values for a resource. This entity can only be used to assign codeValues or create codeValues on the fly.
-
costQuantityType: string
Allowed Values:
[ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ]
The type of costs associated with a resource. -
countryCode: string
Minimum Length:
0
Maximum Length:3
The country for a location. -
defaultUnitsPerHour: integer
(int64)
The default unit/time is the maximum work units per time a resource or role can perform on all their assigned activities. The value is shown as either a percentage or units/duration depending on the user settings. If the Resource Type is Material, then units/duration are always displayed.
For example, if the selected resource is one person, a reasonable value may be 8 hours (units) per day (duration). In this case, the Max Units/Time would be 8.00h/d, or 8 hours of work per day, which is represented as 100%. -
description: string
Minimum Length:
0
Maximum Length:4000
Additional information for the resource or the role. -
emailAddress: string
Minimum Length:
0
Maximum Length:255
The email address for the resource. -
employeeNumber: string
Minimum Length:
0
Maximum Length:60
The resource identifier within the organization, typically the employee number or social security number. -
latitude: number
(double)
Minimum Value:
-90
Maximum Value:90
The geographical coordinate for the latitude of the location.
The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
longitude: number
(double)
Minimum Value:
-180
Maximum Value:180
The geographical coordinate for the longitude of the location.
The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service. -
officePhoneNumber: string
Minimum Length:
0
Maximum Length:32
The office phone number for the resource. -
otherPhoneNumber: string
Minimum Length:
0
Maximum Length:32
The alternate phone numbers for the resource. -
overtimeFactor: number
(double)
The overtime factor used to compute the overtime price for the resource.
-
parentId: integer
(int64)
The unique identifier for the parent resource or role.
-
parentResourceCode: string
Minimum Length:
1
Maximum Length:60
The parent resource code of a resource. -
postalCode: string
Minimum Length:
0
Maximum Length:20
The postal code, post code, or zip code of a location. -
projectAssociationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the resource and the project. Possible values are Owned and Inherited. -
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class identifies the item as a resource or a role. -
resourceCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the resource or role. -
resourceId: integer
(int64)
The unique identifier for the resource or role.
-
resourceManagerId: integer
(int64)
The person designated as the manager for the resource.
-
resourceName: string
Minimum Length:
1
Maximum Length:255
The name of the resource or role. -
resourceOwnershipType: string
Allowed Values:
[ "WORKSPACE", "PROJECT" ]
The type of ownership for a resource. Possible values include Workspace and Project. -
resourceRoleId: integer
(int64)
The identifier for the role assigned to the resource.
-
resourceStatus: string
Allowed Values:
[ "ACTIVE", "INACTIVE" ]
Determines whether the resource or role is currently active.
Inactive resources might have left the organization, but are not deleted from the system because they might have been assigned an activity in the past or have incurred actual hours. -
resourceTitleName: string
Minimum Length:
0
Maximum Length:255
The job title for the resource.
For example, a resource may have the title Senior Engineer. -
resourceType: string
Allowed Values:
[ "LABOR", "NONLABOR", "MATERIAL" ]
The resource type. Valid values are:
Labor: Indicates that the selected resource performs labor, measured in units of time.
Nonlabor: Indicates that the selected resource does not perform labor, measured in units of time. Equipment is a nonlabor resource.
Material: Indicates that the resource has a unit of measure other than time. You can select a unit of measure for the material resource. -
sourceId: string
Maximum Length:
255
The unique identifier of resource data in an external source. -
stateCode: string
Minimum Length:
0
Maximum Length:2
A unique identifier for the state or province. -
stateName: string
Minimum Length:
0
Maximum Length:200
The state, region, or province of a location. -
unitOfMeasureCode: string
Minimum Length:
0
Maximum Length:60
The abbreviation for the unit of measure name. -
unitOfMeasureId: integer
(int64)
The unit of measure used for the material resource.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
-
workspaceName: string
Minimum Length:
1
Maximum Length:255
Name of a workspace.
Nested Schema : codeValuesResource
Type:
array
The list of code values for a resource. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
-
Array of:
object ApiEntityCodeValueResource
Title:
ApiEntityCodeValueResource
Nested Schema : ApiEntityCodeValueResource
Type:
object
Title:
Show Source
ApiEntityCodeValueResource
-
action: string
Allowed Values:
[ "DELETE" ]
Provide a value for this field during object update to delete code value assigned to the object. -
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
This field displays the name of a code or value. -
codeTypeId(required): integer
(int64)
The unique identifier for the code type.The code type object can also be identified by its unique criteria.
-
codeTypeName: string
Minimum Length:
0
Maximum Length:255
The name of a code or value. -
codeValueCode(required): string
Minimum Length:
1
Maximum Length:60
The unique identifier for the code value. -
codeValueId: integer
(int64)
The unique identifier for the code value.
-
codeValueName: string
Minimum Length:
1
Maximum Length:255
The name of the code value. -
codeValueResourceId: integer
(int64)
The unique identifier of the resource assigned to the code value.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
parentId: integer
(int64)
The unique identifier of a parent code value.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The code of a Project of a Project CodeType. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
resourceId: integer
(int64)
The unique identifier for the resource assigned to the code value.
-
sequenceNumber: integer
(int32)
The number that specifies the position of the code value item within the code type list.
-
updateDate: string
(date-time)
Date when the record was last updated.
204 Response
Successful operation with no content.
404 Response
No workspace exists with the given workspace code.