Update a Change Request
put
/primeapi/restapi/changeRequest
Send a request to this endpoint to update a change request. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.
Request
Supported Media Types
- application/json
A change request object.
Root Schema : ApiEntityChangeRequest
Type:
Show Source
object
-
changeRequestId(optional):
integer(int64)
The unique identifier of the change request.
-
description(optional):
string
A summary of the purpose for the change.
-
finalizedById(optional):
integer(int64)
The person who accepts or rejects the change.
-
itemCode:
string
The ID of the change request.
-
itemPrefix(optional):
string
The auto numbering prefix of a code.
-
itemSuffix(optional):
integer(int64)
The auto numbering suffix of a code.
-
link(optional):
string(url)
Read Only:
true
-
maxSuffix(optional):
integer(int64)
The maximum value allowed for a code suffix.
-
projectBaselineId(optional):
integer(int64)
The unique identifier of the project baseline associated with the change request.
-
projectId(optional):
integer(int64)
The ID for the project for which this change request is associated.
-
sourceObjectType(optional):
string
Allowed Values:
[ "SCOPE_ITEM", "WORK_PACKAGE" ]
Type of object on which a change request is operating. Changes can run against scope items or work packages. -
status(optional):
string
Allowed Values:
[ "PENDING", "APPROVED", "REJECTED" ]
The state of the change request.
Pending: The change request is submitted and awaiting a decision.
Approved: The change request was approved.
Rejected: The change request was not approved. -
type(optional):
string
Allowed Values:
[ "CHANGE", "NEW", "TRANSFER" ]
The type of change. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Response
Supported Media Types
- application/json
204 Response
Successful operation with no content.
400 Response
Invalid input for the Change Request service. Verify the request contains valid data, then resubmit the request.