Oracle Prime Cloud Release 16

Returns the resource for the specified resource class.

get

/primeapi/restapi/v16.2/resource

Request

Query Parameters

type

Type: string

Required: true

ResourceClass to get resources

Allowed Values


[
    "resource",
    "role"
]

Response

Supported Media Types

application/json

200 Response

successful operation

Body

Root Schema : ApiEntityResource

Type: object

Properties

addressLine1: Type: string

The first line of the address of a location. This might be the building number and street address.
addressLine2: Type: string

The second line of the address of a location. This might be a neighborhood or town.
applicationUserId: Type: integer (int64)

The name of the user in the application that is also resource.
calendar: Type: integer (int64)

The calendar assigned to the resource or role.
calendarName: Type: string

The name of the calendar.
cityName: Type: string

The city name for a location.
codeValuesResource: Type: array codeValuesResource

Unique Items Required: true

Lists all resource code types assigned to the resource with its corresponding value.
costQuantityType: Type: string

Allowed Values: [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ]
countryCode: Type: string

The country for a location.
defaultSyncUnitsFromCost: Type: boolean

Default Value: false
defaultUnitsPerHour: Type: object Unit
description: Type: string

Additional information for the resource or the role.
emailAddress: Type: string

The email address for the resource.
employeeNumber: Type: string

The resource identifier within the organization, typically the employee number or social security number.
latitude: Type: number (double)

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.
locationName: Type: string

The geographical location of the resource.
longitude: Type: number (double)

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: Type: string

The office phone number for the resource.
otherPhoneNumber: Type: string

The alternate phone numbers for the resource.
overtimeFactor: Type: number (double)
parent: Type: integer (int64)
parentResourceCode: Type: string
postalCode: Type: string

The postal code, post code, or zip code of a location.
resourceClass: Type: string

Allowed Values: [ "RESOURCE", "ROLE" ]

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.
resourceCode: Type: string

The unique identifier for the resource or role.
resourceId: Type: integer (int64)
resourceManagerId: Type: integer (int64)

The person designated as the manager for the resource.
resourceName: Type: string

The name of the resource or role.
resourceRoleId: Type: integer (int64)

The identifier for the role assigned to the resource.
resourceStatus: Type: string

Allowed Values: [ "ACTIVE", "INACTIVE" ]

Determines whether the resource or role is currently active. Non-active resources might have left the organization, but are not deleted from the system since they might have been assigned an activity in the past or have incurred actual hours.
resourceTitleName: Type: string

The job title for the resource. For example, a resource may have the title Senior Engineer.
resourceType: Type: 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.
stateCode: Type: string

A unique identifier for the state or province.
stateName: Type: string

The state, region, or province of a location.
unitOfMeasure: Type: integer (int64)

The unit of measure used for the material resource.
workspace: Type: integer (int64)

The name of the workspace where the resource or role was created.
workspaceName: Type: string

The name of the workspace.

Nested Schema : codeValuesResource

Type: array

Unique Items Required: true

Lists all resource code types assigned to the resource with its corresponding value.

Items

Type: object ApiEntityCodeValueResource

Nested Schema : Unit

Type: object

Nested Schema : ApiEntityCodeValueResource

Type: object

Properties

codeType: Type: object ApiEntityCodeType
codeValue: Type: object ApiEntityCodeValue
codeValueResourceId: Type: integer (int64)

The unique identifier for the code value assigned to the resource.

Nested Schema : ApiEntityCodeType

Type: object

Properties

assignments: Type: array assignments

Unique Items Required: true
codeTypeCode: Type: string

Allowed Values: [ "Length[1-40]" ]

This field displays the name of a code or value.
codeTypeId: Type: integer (int64)
codeTypeName: Type: string

Allowed Values: [ "Length[1-40]" ]

STRING
workspace: Type: integer (int64)

The ID of the owning workspace.

Nested Schema : ApiEntityCodeValue

Type: object

Properties

codeTypeId: Type: integer (int64)

The ID for the code type.
codeValueCode: Type: string

Allowed Values: [ "LENGTH[1-32]" ]

The unique identifier for the code value.
codeValueId: Type: integer (int64)

The unique identifier for the code value.
codeValueName: Type: string

Allowed Values: [ "LENGTH[1-100]" ]

The name of the code value.
parentCodeValue: Type: integer (int64)

The parent code value.
sequenceNumber: Type: integer (int32)

The number that specifies the position of the code value item within the code type list.

Nested Schema : assignments

Type: array

Unique Items Required: true

Items

Type: object ApiEntityCodeEntityType

Nested Schema : ApiEntityCodeEntityType

Type: object

Properties

codeType: Type: object ApiEntityCodeType
entityType: Type: string

Allowed Values: [ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "PROJECT_FUND", "WORKSPACE_FUND" ]
primaryKey: Type: integer (int64)