Get a project asset
get
/fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}
Request
Path Parameters
-
projectAssetsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Project Assets resource and used to uniquely identify an instance of Project Assets. The client should not generate the hash key value. Instead, the client should query on the Project Assets collection resource in order to navigate to a specific instance of Project Assets to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
Root Schema : projectAssets-item-response
Type:
Show Source
object
-
AmortizeFlag: boolean
Title:
Amortize Adjustments
Maximum Length:1
Default Value:false
Indicates whether cost adjustments should be amortized in Oracle Assets. The two options are Y and N. The default value is N. -
AssetCategoryCombination: string
Title:
Asset Category
Segment values for asset categories, concatenated using a delimiter. -
AssetCategoryId: integer
(int64)
Title:
Asset Category ID
Identifier of the asset category to which the asset is assigned. You may enter either this attribute, the asset category, or both. -
AssetDescription: string
Title:
Description
Maximum Length:80
Description of the project asset that identifies an asset within a project upon transfer to Oracle Assets. This is a mandatory attribute. -
AssetKeyCombination: string
Title:
Asset Key
Segment values for asset keys, concatenated using a delimiter. -
AssetKeyIdentifier: integer
(int64)
Title:
Asset Key ID
Identifier of the key flexfield code combination for the asset. You may enter either this attribute, the asset key, or both. -
AssetName: string
Title:
Asset Name
Maximum Length:240
Name of the project asset that identifies an asset within a project. This is a mandatory attribute. -
AssetNumber: string
Title:
Asset Number
Maximum Length:30
The project asset number that identifies an asset in a project. This is a mandatory attribute, and can be user-defined or generated by Fixed Assets. You must provide the asset number and FA asset ID in Patch mode to associate the FA asset with the project asset. -
AssetUnits: number
Title:
Actual Units
The number of asset units. -
AssignedToPersonId: integer
(int64)
Title:
Person ID
Identifier of the individual to whom the asset is assigned. You may enter either this attribute, the person name, or person number when assigning an individual to an asset. -
AssociateFAToPPMAssetFlag: boolean
Default Value:
false
Indicates whether the asset number recorded exists in Fixed Assets. The two options are Y and N. The default value is N. -
BookTypeCode: string
Title:
Book Type Code
Maximum Length:30
The corporate book to which the asset is assigned. -
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Identifier of the business unit associated with the project in which the asset has been assigned. This is a mandatory attribute. -
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit associated with the project in which the asset has been assigned. -
CapitalEventId: integer
(int64)
Title:
Event ID
Identifier of the event that's assigned to the project asset. You may enter either this attribute, the event number, or the event name. -
CapitalEventNumber: integer
(int64)
Title:
Event Number
Number of the event that's assigned to the project asset. You may enter either this attribute, the event ID, or the event name. -
CapitalHoldFlag: boolean
Title:
Capital Hold
Maximum Length:1
Default Value:false
Indicates whether the generation of new asset lines should be prevented. This is a mandatory attribute. The two options are Y and N. The default value is N. -
CapitalizedCost: number
Title:
Capitalized Cost
Read Only:true
Default Value:0
The cost amount that has been interfaced to Oracle Assets for capitalization. -
CapitalizedDate: string
(date)
Title:
Capitalized Date
Read Only:true
The last date on which nonreversing cost adjustments were interfaced to Oracle Assets. -
CapitalizedFlag: boolean
Title:
Capitalized
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether the asset has been interfaced to Oracle Assets. The two options are Y and N. The default value is N. -
CostAdjustmentFlag: boolean
Title:
Cost Adjustment
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether asset cost adjustments have been interfaced to Oracle Assets. The two options are Y and N. The default value is N. -
DatePlacedInService: string
(date)
Title:
Actual In-Service Date
The date on which an asset is placed in service. -
DepreciateFlag: boolean
Title:
Depreciate
Maximum Length:1
Default Value:true
Indicates whether the asset should be depreciated in Oracle Assets. The two options are Y and N. The default value is Y. -
DepreciationExpenseAccountCombination: string
Title:
Depreciation Expense Account
Segment values for depreciation expense accounts, concatenated using delimiters. -
DepreciationExpenseIdentifier: integer
(int64)
Title:
Depreciation Expense ID
Identifier of the depreciation expense account for the asset. You may enter either this attribute, the depreciation expense account, or both. -
EstimatedAssetUnits: number
Title:
Estimated Units
The estimated number of asset units. -
EstimatedCost: number
Title:
Estimated Cost
The estimated cost of the asset. -
EstimatedInServiceDate: string
(date)
Title:
Estimated In-Service Date
The estimated date on which an asset is placed in service. -
EventName: string
Title:
Event Name
Maximum Length:240
Name of the event that's assigned to the project asset. You may enter either this attribute, the event number, or the event ID. -
FixedAssetsAssetId: integer
(int64)
Title:
Asset ID
Identifier of the asset in Oracle Fixed Assets used for tieback purposes. Users must provide the asset number along with the FA asset ID in PATCH mode if they're trying to associate an Oracle FA asset with the Projects asset. -
FixedAssetsPeriodName: string
Title:
Fixed Assets Period Name
Maximum Length:15
Period into which an asset was posted in Fixed Assets. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationCombination: string
Title:
Location
Segment values for location, concatenated using delimiters. -
LocationId: integer
(int64)
Title:
Location ID
Identifier of the location to which the asset is assigned. You may enter either this attribute, the location, or both when assigning a location to the asset. -
ManufacturerName: string
Title:
Manufacturer
Maximum Length:30
The name of the asset manufacturer. -
ModelNumber: string
Title:
Model Number
Maximum Length:40
The model number of the asset. -
NewMasterFlag: boolean
Title:
Override Category and Description
Maximum Length:1
Default Value:false
Determines whether this cost adjustment will reclassify the asset within Oracle Assets. -
ParentAssetDescription: string
Title:
Parent Asset Description
Maximum Length:80
Description of the parent asset in which multiple assets can be identified. You may enter a combination of this attribute, the parent asset ID, or the parent asset number when associating an asset to a parent asset. -
ParentAssetId: integer
(int64)
Title:
Parent Asset ID
Identifier of the parent asset in which multiple assets can be identified. You may enter a combination of this attribute, the parent asset description, or the parent asset number when associating an asset to a parent asset. -
ParentAssetNumber: string
Title:
Parent Asset Number
Maximum Length:30
Number of the parent asset in which multiple assets can be identified. You may enter a combination of this attribute, the parent asset ID, or the parent asset description when associating an asset to a parent asset. -
PersonName: string
Title:
Person Name
Maximum Length:240
Name of the individual to whom the asset is assigned. You may enter either this attribute, the person Id, or person number when assigning an individual to an asset. -
PersonNumber: string
Title:
Person Number
Maximum Length:30
Number of the individual to whom the asset is assigned. You may enter either this attribute, the person ID, or the person name when assigning an individual to an asset. -
ProjectAssetAssignments: array
Project Asset Assignments
Title:
Project Asset Assignments
The project asset assignment resource is used to view, create, update, and delete project asset assignments, including those from Project Portfolio Management and those imported from third-party applications. -
ProjectAssetDff: array
ProjectAssetDff
-
ProjectAssetId: integer
(int64)
Title:
Project Asset ID
The unique identifier of a system-generated project asset. This is a mandatory attribute. -
ProjectAssetType: string
Title:
Project Asset Type
Maximum Length:30
The identifier that determines when project costs become an asset. This is a mandatory attribute. It can be either ESTIMATED, AS-BUILT, or RETIREMENT_ADJUSTMENT. The default value is ESTIMATED. -
ProjectId: integer
(int64)
Title:
Project ID
Identifier of the project to which the asset belongs. You can enter either this attribute, the project name, or the project number while creating an asset. -
ProjectName: string
Title:
Project Name
Maximum Length:240
Name of the project to which the asset belongs. You can enter either this attribute, the project ID, or the project number while creating an asset. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Number of the project to which the asset belongs. You can enter either this attribute, the project ID, or the project name while creating an asset. -
RetirementTargetAssetDescription: string
Title:
Retirement Asset Description
Maximum Length:80
Description of the asset used to capture retirement costs when another asset, or assets, retire. You may enter this attribute, Retirement Target Asset ID, or Retirement Target Asset Number, when selecting an asset to capture the retirement costs. -
RetirementTargetAssetId: integer
(int64)
Title:
Retirement Asset ID
The asset identifier used to capture retirement costs when another asset, or assets retire. You may enter either this attribute, the retirement target asset description, or the retirement target asset number when selecting an asset to capture the retirement costs. -
RetirementTargetAssetNumber: string
Title:
Retirement Asset Number
Maximum Length:30
Number of the asset used to capture the retirement costs when another asset or assets retire. You may enter this attribute, the retirement target asset ID, or the retirement target asset description when selecting an asset to capture the retirement costs. -
ReversalDate: string
(date)
Title:
Reversal Date
Read Only:true
The last date on which reversing asset lines were created. This is a system-generated date. -
ReverseFlag: boolean
Title:
Reverse
Maximum Length:1
Default Value:false
Indicates whether the asset will be reversed in the next Generate Asset Lines run. This is a mandatory attribute. The two options are Y and N. The default value is N. -
SerialNumber: string
Title:
Serial Number
Maximum Length:35
The serial number of the asset. -
SourceApplication: string
Title:
Source Application
Maximum Length:30
Identifier of the external project management system from which the project was imported. -
SourceReference: string
Title:
Source Reference
Maximum Length:240
Identifier of the project in the external project management system from which the project was imported. -
TagNumber: string
Title:
Tag Number
Maximum Length:15
Tag number of the asset. -
TotalAssetCost: number
Title:
Total Asset Cost
Read Only:true
Default Value:0
The asset's cost amount, grouped into asset lines.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Project Asset Assignments
Type:
array
Title:
Project Asset Assignments
The project asset assignment resource is used to view, create, update, and delete project asset assignments, including those from Project Portfolio Management and those imported from third-party applications.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : projectAssets-ProjectAssetAssignments-item-response
Type:
Show Source
object
-
AssetAssignmentId: integer
(int64)
Title:
Asset Assignment ID
The system-generated identifier of the asset assignment transaction. This is a mandatory attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectAssetId: integer
(int64)
Title:
Project Asset ID
Identifier of a project asset. This is a mandatory attribute. -
ProjectId: integer
(int64)
Title:
Project ID
The identifier of the project to which asset assignment is made. You can enter either this attribute, the project name, or the project number while creating an asset assignment. -
ProjectName: string
Title:
Project Name
Maximum Length:240
The name of the project to which asset assignment is made. You can enter either this attribute, the project ID, or the project number while creating an asset assignment. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
The number of the project to which asset assignment is made. You must enter either this attribute, the project ID, or the project name while creating an asset assignment. -
TaskId: integer
(int64)
Title:
Task ID
The identifier of the task to which asset assignment is made. This is a mandatory attribute. You must enter at least this attribute, or the task name or number while creating an asset assignment. The value is 0 on project-level assignments. -
TaskName: string
Title:
Task Name
Maximum Length:255
The name of the task to which asset assignment is made. You must enter at least this attribute, the task ID, or the task number while creating an asset assignment. -
TaskNumber: string
Title:
Task Number
Maximum Length:100
The number of the task to which asset assignment is made. You must enter at least this attribute, the task ID, or the Task Name while creating an asset assignment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectAssets-ProjectAssetDff-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectAssetId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ProjectAssetAssignments
-
Operation: /fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}/child/ProjectAssetAssignmentsParameters:
- projectAssetsUniqID:
$request.path.projectAssetsUniqID
The project asset assignment resource is used to view, create, update, and delete project asset assignments, including those from Project Portfolio Management and those imported from third-party applications. - projectAssetsUniqID:
- ProjectAssetDff
-
Operation: /fscmRestApi/resources/11.13.18.05/projectAssets/{projectAssetsUniqID}/child/ProjectAssetDffParameters:
- projectAssetsUniqID:
$request.path.projectAssetsUniqID
- projectAssetsUniqID:
Examples
The following example shows how to get a project asset by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectAssets/100000016707668
Response Body Example
The following shows an example of the response body in JSON format of all project templates.
{ "ProjectAssetId": 100000016707668, "ProjectId": 100000016707275, "ProjectName": "T, Construction (VS)", "ProjectNumber": "T, Construction (VS)", "ProjectAssetType": "ESTIMATED", "AssetName": "Air Conditioner", "AssetNumber": null, "AssetDescription": "Air Conditioner", "CapitalEventId": null, "EventName": null, "CapitalEventNumber": null, "EstimatedInServiceDate": null, "DatePlacedInService": null, "CapitalizedFlag": false, "CapitalizedDate": null, "CapitalizedCost": 0, "TotalAssetCost": 0, "ReverseFlag": false, "ReversalDate": null, "CapitalHoldFlag": false, "BookTypeCode": "SVCS CORP", "AssetCategoryId": null, "AssetKeyIdentifier": null, "AssetUnits": null, "EstimatedCost": null, "EstimatedAssetUnits": null, "SourceApplication": null, "SourceReference": null, "LocationId": null, "AssignedToPersonId": null, "PersonName": null, "PersonNumber": null, "DepreciateFlag": true, "DepreciationExpenseIdentifier": null, "AmortizeFlag": false, "CostAdjustmentFlag": false, "NewMasterFlag": false, "BusinessUnitId": 458, "BusinessUnitName": "Vision Services", "FixedAssetsAssetId": null, "FixedAssetsPeriodName": null, "ParentAssetId": null, "ParentAssetDescription": null, "ParentAssetNumber": null, "ManufacturerName": null, "ModelNumber": null, "TagNumber": null, "SerialNumber": null, "RetirementTargetAssetId": null, "RetirementTargetAssetDescription": null, "RetirementTargetAssetNumber": null, "LocationCombination": null, "AssetKeyCombination": null, "AssetCategoryCombination": null, "DepreciationExpenseAccountCombination": null, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectAssets/100000016707668", "name": "projectAssets", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectAssets/100000016707668", "name": "projectAssets", "kind": "item" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectAssets/100000016707668/lov/ParentAssetNumberVVOVA", "name": "ParentAssetNumberVVOVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectAssets/100000016707668/lov/SimplePersonPVOVA", "name": "SimplePersonPVOVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectAssets/100000016707668/lov/CapitalEventVOVA", "name": "CapitalEventVOVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectAssets/100000016707668/lov/ProjectPVOVA", "name": "ProjectPVOVA", "kind": "collection" }, { "rel": "lov", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectAssets/100000016707668/lov/BusinessUnitPVOVA", "name": "BusinessUnitPVOVA", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectAssets/100000016707668/child/ProjectAssetAssignments", "name": "ProjectAssetAssignments", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectAssets/100000016707668/child/ProjectAssetDff", "name": "ProjectAssetDff", "kind": "collection" } ] }