Get a project change request
get
/fscmRestApi/resources/11.13.18.05/projectChangeRequests/{ChangeRequestId}
Request
Path Parameters
-
ChangeRequestId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
Metadata-Context: string
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: string
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:
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.
Root Schema : projectChangeRequests-item-response
Type:
Show Source
object
-
ApprovalDate: string
(date)
Title:
Approval Date
The date the approval or cancellation decision of the change request was made. -
ApproverId: integer
(int64)
Title:
Approver ID
The identifier of the project person who made the approval or cancellation decision for the change request. -
ApproverName: string
Title:
Approver Name
The name of the project person who made the approval or cancellation decision for the change request. -
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CancellationReason: string
Title:
Cancellation Reason
Maximum Length:255
The cancellation reason for a canceled change request such as duplicate, not required, or rejected. -
CancellationReasonCode: string
Title:
Cancellation Reason Code
Maximum Length:30
Identifier for the cancellation reason type, decoded using the lookup type ORA_PJE_CR_CANCEL_TYPE. -
ChangeRequestId: integer
(int64)
Title:
Change Request ID
The unique identifier of the change request. -
Comments: string
Title:
Comments
Maximum Length:2000
Comments for the change request. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreatedByPersonId: integer
(int64)
The user who created the record.
-
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
Description: string
Title:
Description
Maximum Length:2000
Description of the change request. -
FinancialImpactDetails: array
Financial Impact Details
Title:
Financial Impact Details
-
ImpactIfNotImpl: string
Title:
Impact if Not Implemented
Maximum Length:2000
Impact if the change request isn't implemented. -
Justification: string
Title:
Justification
Maximum Length:2000
Justification for the change request. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:100
The name of the change request. -
Number: string
Title:
Number
Maximum Length:100
The number of the change request. -
OwnerEmail: string
Title:
Owner Email
Maximum Length:255
The email of the project person who owns the change request. -
OwnerId: integer
(int64)
Title:
Owner ID
The identifier of the project person who owns the change request. -
OwnerName: string
Title:
Owner Name
Maximum Length:255
The name of the project person who owns the change request. -
Priority: string
Title:
Priority
Maximum Length:255
The relative importance of the change request such as high, medium, or low. -
PriorityCode: string
Title:
Priority Code
Maximum Length:30
Identifier for the priority, decoded using the lookup type PJE_CHANGE_PRIORITY. -
ProjectId: integer
(int64)
Title:
Project ID
The identifier of the project associated with the change request. -
ProjectName: string
Title:
Project Name
The name of the project associated with the change request. -
ProjectNumber: string
Title:
Project Number
The number of the project associated with the change request. -
Reason: string
Title:
Reason
Maximum Length:255
The reason summarizes the need for the change request, such as a new requirement, technical issue, or design error. -
ReasonCode: string
Title:
Reason Code
Maximum Length:30
Identifier for the change request reason type, decoded using the lookup type ORA_PJE_CR_REASON. -
RejectionReason: string
Title:
Rejection Reason
Maximum Length:255
The rejection reason for a change request such as high risk or more information requested. -
RejectionReasonCode: string
Title:
Rejection Reason Code
Maximum Length:30
Identifier for the rejection reason type, decoded using the lookup type ORA_PJE_CR_REJECT_TYPE. -
Status: string
Title:
Status
Maximum Length:255
The status of the change request, for example approved or rejected. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The code that represents the status of the change request such as new, submitted, approved, or canceled. -
TaskImpactDetails: array
Task Impact Details
Title:
Task Impact Details
The Task Impact Details resource is used to view, create, update, or delete the task impact details for a change request. This resource captures the proposed modifications to an ongoing project timeline by suggesting date adjustments for existing tasks or introducing new tasks altogether.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Task Impact Details
Type:
array
Title:
Task Impact Details
The Task Impact Details resource is used to view, create, update, or delete the task impact details for a change request. This resource captures the proposed modifications to an ongoing project timeline by suggesting date adjustments for existing tasks or introducing new tasks altogether.
Show Source
Nested Schema : projectChangeRequests-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : projectChangeRequests-FinancialImpactDetails-item-response
Type:
Show Source
object
-
ApprovalComments: string
Title:
Approval Comments
Maximum Length:2000
-
ApprovalDate: string
(date)
Title:
Approval Date
-
ApproverId: integer
(int64)
Title:
Approver ID
-
ApproverName: string
Title:
Approver Name
Maximum Length:255
-
AreaCode: string
Title:
Area Code
Maximum Length:30
-
BurdenedCost: number
Title:
Burdened Cost
-
BurdenedCostInProjectCurrency: number
Title:
Burdened Cost in Project Currency
-
BurdenedCostInProjectLedgerCurrency: number
Title:
Burdened Cost in Project Ledger Currency
-
ChangeOrderId: integer
(int64)
Title:
Change Order ID
-
ChangeOrderImpactDetailsId: integer
(int64)
Title:
Change Order Impact Detail ID
-
ChangeOrderImpactId: integer
(int64)
Title:
Change Order Impact ID
-
ChangeOrderName: string
Title:
Change Order Name
Maximum Length:255
-
ChangeOrderNumber: integer
(int64)
Title:
Change Order Name
-
ChangeOrderStatus: string
Title:
Change Order Status
Read Only:true
Maximum Length:255
-
ChangeRequestId: integer
(int64)
Title:
Change Request ID
-
ImpactDetailsId: integer
(int64)
Title:
Impact Details ID
-
ImpactTo: string
Title:
Impact To
Maximum Length:30
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanningCurrencyCode: string
Title:
Planning Currency Code
Maximum Length:15
-
ProjectId: integer
(int64)
Title:
Project ID
-
ProjectName: string
Title:
Project Name
-
ProjectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
-
ProposedFinishDate: string
(date)
Title:
Proposed Finish Date
-
ProposedStartDate: string
(date)
Title:
Proposed Start Date
-
Quantity: number
Title:
Quantity
-
RawCost: number
Title:
Raw Cost
-
RawCostInProjectCurrency: number
Title:
Raw Cost in Project Currency
-
RawCostInProjectLedgerCurrency: number
Title:
Raw Cost in Project Ledger Currency
-
ResourceId: integer
(int64)
Title:
Resource ID
-
ResourceName: string
Title:
Resource Name
Maximum Length:255
-
Revenue: number
Title:
Revenue
-
RevenueCostInProjectCurrency: number
Title:
Revenue in Project Currency
-
RevenueCostInProjectLedgerCurrency: number
Title:
Revenue in Project Ledger Currency
-
Status: string
Title:
Status
Maximum Length:255
-
StatusCode: string
Title:
Status Code
Maximum Length:30
-
TaskId: integer
(int64)
Title:
Task ID
-
TaskName: string
Title:
Task Name
Maximum Length:255
-
TaskNumber: string
Title:
Task Number
Maximum Length:255
-
UnitOfMeasureCode: string
Title:
Unit of Measure
Maximum Length:30
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectChangeRequests-TaskImpactDetails-item-response
Type:
Show Source
object
-
Action: string
Title:
Action
Maximum Length:10
Specifies the type of task impact. A value of CREATE denotes the proposal for a new task, while a value of UPDATE indicates modifications to an existing task using the change request. -
ApprovalComments: string
Title:
Approval Comments
Maximum Length:2000
The justification for either approving or rejecting the change request impact detail. -
ApprovalDate: string
(date)
Title:
Approval Date
The date when the approval decision of the change request impact detail was made. -
ApproverId: integer
(int64)
Title:
Approver ID
The identifier of the project person who made the approval decision for the change request impact detail. -
ApproverName: string
Title:
Approver Name
Maximum Length:255
The name of the project person who made the approval decision on the change request impact detail. -
AreaCode: string
Title:
Area Code
Maximum Length:30
Identifier for the change request impact detail type, decoded using the lookup type ORA_PJE_CR_IMPACT_AREA. -
ChangeOrderId: integer
(int64)
Title:
Change Order ID
Identifier of the change order, if any, that the change request impact detail is associated with. -
ChangeOrderImpactDetailsId: integer
(int64)
Title:
Change Order Impact Detail ID
Identifier of the change order impact detail, if any, that the change request impact detail is associated with. -
ChangeOrderImpactId: integer
(int64)
Title:
Change Order Impact ID
Identifier of the change order impact, if any, that the change request impact detail is associated with. -
ChangeOrderName: string
Maximum Length:
255
The name of the change order, if any, that the change request impact detail is associated with. -
ChangeOrderNumber: integer
(int64)
The number of the change order, if any, that the change request impact detail is associated with.
-
ChangeOrderStatus: string
Title:
Change Order Status
Read Only:true
Maximum Length:255
The status of the change order, if any, that the change request impact detail is associated with. -
ChangeOrderStatusCode: string
Title:
Change Order Status Code
Read Only:true
Maximum Length:30
The status code of the change order, if any, that the change request impact detail is associated with. -
ChangeRequestId: integer
(int64)
Title:
Change Request ID
The identifier of the change request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MilestoneFlag: boolean
Title:
Milestone
Maximum Length:1
Indicates whether the impacted task is a milestone. Value of True indicates that the task is a milestone. The default value is False. -
ParentTaskId: integer
(int64)
Title:
Parent Task ID
The identifier of the parent task of a new task proposed or a task impacted with the change request. -
ParentTaskName: string
Title:
Parent Task Name
Maximum Length:255
The name of the parent task of a new task proposed or a task impacted with the change request. -
ParentTaskNumber: string
Title:
Parent Task Number
Maximum Length:255
The number of the parent task of a new task proposed or a task impacted with the change request. -
ProjectId: integer
(int64)
Title:
Project ID
The identifier of the project associated with the change request. -
ProjectName: string
Title:
Project Name
Read Only:true
Maximum Length:240
The name of the project associated with the change request. -
ProjectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
The number of the project associated with the change request. -
ProposedFinishDate: string
(date)
Title:
Proposed Finish Date
The proposed finish date of the task in change impact task details. -
ProposedStartDate: string
(date)
Title:
Proposed Start Date
The proposed start date of the task in the change impact task details. -
Status: string
Title:
Status
Maximum Length:255
The status of the change request impact detail such as approved or rejected. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The code that represents the status of the change impact detail such as approved or rejected. -
TaskId: integer
(int64)
Title:
Task ID
The identifier of the task that's impacted due to the change request. -
TaskImpactDetailsId: integer
(int64)
Title:
Task Impact Detail ID
The unique identifier of the change request task impact assessment. -
TaskName: string
Title:
Task Name
Maximum Length:100
The name of the task that's impacted due to the change request. -
TaskNumber: string
Title:
Task Number
Maximum Length:100
The number of the task that's impacted due to the change request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Operation: /fscmRestApi/resources/11.13.18.05/projectChangeRequests/{ChangeRequestId}/child/AttachmentsParameters:
- ChangeRequestId:
$request.path.ChangeRequestId
The attachments resource is used to view, create, and update attachments. - ChangeRequestId:
- FinancialImpactDetails
-
Parameters:
- ChangeRequestId:
$request.path.ChangeRequestId
- ChangeRequestId:
- TaskImpactDetails
-
Operation: /fscmRestApi/resources/11.13.18.05/projectChangeRequests/{ChangeRequestId}/child/TaskImpactDetailsParameters:
- ChangeRequestId:
$request.path.ChangeRequestId
The Task Impact Details resource is used to view, create, update, or delete the task impact details for a change request. This resource captures the proposed modifications to an ongoing project timeline by suggesting date adjustments for existing tasks or introducing new tasks altogether. - ChangeRequestId: