Update a Change Request
put
/api/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
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityChangeRequest
Type:
object
Title:
ApiEntityChangeRequest
This entity represents a ChangeRequest object, a unique ChangeRequest object can be identified by the following combinations of the fields.
Show Source
- changeRequestId
- changeRequestCode,projectId
- changeRequestCode,projectCode,workspaceCode
-
approvalDate: string
(date-time)
Read Only:
true
The date the change request was approved. -
changeRequestCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier of the change request. -
changeRequestId: integer
(int64)
The unique identifier of the change request.
-
description: string
Minimum Length:
0
Maximum Length:4000
A summary of the purpose for the change. -
finalizedById: integer
(int64)
The user who accepted the change request.
-
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
maxSuffix: integer
(int64)
The maximum value allowed for a code suffix.
-
projectBaselineId: integer
(int64)
The unique identifier of the project baseline associated with the change request.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId(required): integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
rejectedByUserId: integer
(int64)
Read Only:
true
The user who rejected the change request. -
rejectedDate: string
(date-time)
Read Only:
true
The date the change request was rejected. -
reopenedByUserId: integer
(int64)
Read Only:
true
The user who reopened the rejected change request. -
reopenedDate: string
(date-time)
Read Only:
true
The date the rejected change request was reopened. -
sourceObjectType(required): 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: string
Allowed Values:
[ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ]
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: string
Allowed Values:
[ "CHANGE", "NEW", "TRANSFER" ]
The type of change. -
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated. -
withdrawnApprovalByUserId: integer
(int64)
Read Only:
true
The user who withdrew approval of the change request. -
withdrawnApprovalDate: string
(date-time)
Read Only:
true
The date the approved change request was withdrawn. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Response
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.