View Program Budget Change Status Transition History Records by Program
get
/api/restapi/programBudgetChange/program/{programId}/statusTransitionHistory
This endpoint returns status transition history records of program budget changes that meet the following requirements:
- The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
Request
Path Parameters
-
programId(required): integer(int64)
The system-generated unique identifier of a program.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityProgramBudgetChangeStatusTransitionHistory>
Type:
array
Title:
Show Source
List<ApiEntityProgramBudgetChangeStatusTransitionHistory>
-
Array of:
object ApiEntityProgramBudgetChangeStatusTransitionHistory
Title:
ApiEntityProgramBudgetChangeStatusTransitionHistory
Nested Schema : ApiEntityProgramBudgetChangeStatusTransitionHistory
Type:
object
Title:
Show Source
ApiEntityProgramBudgetChangeStatusTransitionHistory
-
comment: string
Minimum Length:
0
Maximum Length:4000
Comments included by the user who changed the status of the record. -
date: string
(date-time)
The date the status of the record was changed.
-
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. -
programBudgetChangeId: integer
(int64)
The system-generated identifier of a budget change.
-
programBudgetChangeStatusTransitionHistoryId: integer
(int64)
The system-generated identifier of a budget change status transition history.
-
statusTransitionType: string
Allowed Values:
[ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "REJECT", "DRAFT" ]
The type of change made to the record. -
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated. -
userId: integer
(int64)
The user who changed the status of the record.
-
userName: string
Maximum Length:
255
The name of a user associated with the status transition history.
204 Response
Successful operation with no content.
404 Response
The requested status transition history record does not exist, or you do not have access to it.