Get all project change requests

get

/fscmRestApi/resources/11.13.18.05/projectChangeRequests

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 a change request with the specified primary key.
      Finder Variables
      • ChangeRequestId; integer; The unique identifier of a project change request.
  • 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:
    • ApprovalDate; string; The date the approval or cancellation decision of the change request was made.
    • ApproverId; integer; The identifier of the project person who made the approval or cancellation decision for the change request.
    • ApproverName; string; The name of the project person who made the approval or cancellation decision for the change request.
    • CancellationReason; string; The cancellation reason for a canceled change request such as duplicate, not required, or rejected.
    • CancellationReasonCode; string; Identifier for the cancellation reason type, decoded using the lookup type ORA_PJE_CR_CANCEL_TYPE.
    • ChangeRequestId; integer; The unique identifier of the change request.
    • Comments; string; Comments for the change request.
    • CreatedBy; string; The user who created the record.
    • CreatedByPersonId; integer; The user who created the record.
    • CreationDate; string; The date and time when the record was created.
    • Description; string; Description of the change request.
    • ImpactIfNotImpl; string; Impact if the change request isn't implemented.
    • Justification; string; Justification for the change request.
    • LastUpdateDate; string; The date and time when the record was last updated.
    • Name; string; The name of the change request.
    • Number; string; The number of the change request.
    • OwnerEmail; string; The email of the project person who owns the change request.
    • OwnerId; integer; The identifier of the project person who owns the change request.
    • OwnerName; string; The name of the project person who owns the change request.
    • Priority; string; The relative importance of the change request such as high, medium, or low.
    • PriorityCode; string; Identifier for the priority, decoded using the lookup type PJE_CHANGE_PRIORITY.
    • ProjectId; integer; The identifier of the project associated with the change request.
    • ProjectName; string; The name of the project associated with the change request.
    • ProjectNumber; string; The number of the project associated with the change request.
    • Reason; string; The reason summarizes the need for the change request, such as a new requirement, technical issue, or design error.
    • ReasonCode; string; Identifier for the change request reason type, decoded using the lookup type ORA_PJE_CR_REASON.
    • RejectionReason; string; The rejection reason for a change request such as high risk or more information requested.
    • RejectionReasonCode; string; Identifier for the rejection reason type, decoded using the lookup type ORA_PJE_CR_REJECT_TYPE.
    • Status; string; The status of the change request, for example approved or rejected.
    • StatusCode; string; The code that represents the status of the change request such as new, submitted, approved, or canceled.
  • 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 : projectChangeRequests
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : projectChangeRequests-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Financial Impact Details
Type: array
Title: Financial Impact Details
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: object
Show Source
Nested Schema : projectChangeRequests-FinancialImpactDetails-item-response
Type: object
Show Source
Nested Schema : projectChangeRequests-TaskImpactDetails-item-response
Type: object
Show Source
  • 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.
  • Title: Approval Comments
    Maximum Length: 2000
    The justification for either approving or rejecting the change request impact detail.
  • Title: Approval Date
    The date when the approval decision of the change request impact detail was made.
  • Title: Approver ID
    The identifier of the project person who made the approval decision for the change request impact detail.
  • Title: Approver Name
    Maximum Length: 255
    The name of the project person who made the approval decision on the change request impact detail.
  • Title: Area Code
    Maximum Length: 30
    Identifier for the change request impact detail type, decoded using the lookup type ORA_PJE_CR_IMPACT_AREA.
  • Title: Change Order ID
    Identifier of the change order, if any, that the change request impact detail is associated with.
  • Title: Change Order Impact Detail ID
    Identifier of the change order impact detail, if any, that the change request impact detail is associated with.
  • Title: Change Order Impact ID
    Identifier of the change order impact, if any, that the change request impact detail is associated with.
  • Maximum Length: 255
    The name of the change order, if any, that the change request impact detail is associated with.
  • The number of the change order, if any, that the change request impact detail is associated with.
  • 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.
  • 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.
  • Title: Change Request ID
    The identifier of the change request.
  • Links
  • 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.
  • Title: Parent Task ID
    The identifier of the parent task of a new task proposed or a task impacted with the change request.
  • 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.
  • 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.
  • Title: Project ID
    The identifier of the project associated with the change request.
  • Title: Project Name
    Read Only: true
    Maximum Length: 240
    The name of the project associated with the change request.
  • Title: Project Number
    Read Only: true
    Maximum Length: 25
    The number of the project associated with the change request.
  • Title: Proposed Finish Date
    The proposed finish date of the task in change impact task details.
  • Title: Proposed Start Date
    The proposed start date of the task in the change impact task details.
  • Title: Status
    Maximum Length: 255
    The status of the change request impact detail such as approved or rejected.
  • Title: Status Code
    Maximum Length: 30
    The code that represents the status of the change impact detail such as approved or rejected.
  • Title: Task ID
    The identifier of the task that's impacted due to the change request.
  • Title: Task Impact Detail ID
    The unique identifier of the change request task impact assessment.
  • Title: Task Name
    Maximum Length: 100
    The name of the task that's impacted due to the change request.
  • Title: Task Number
    Maximum Length: 100
    The number of the task that's impacted due to the change request.
Back to Top