View all Program Budget Status Transition History by Program
get
/api/restapi/programBudget/program/{programId}/statusTransitionHistory
This endpoint returns a program budget status transition history that meet the following requirements:
- The object is associated with 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<ApiEntityProgramBudgetStatusTransitionHistory>
Type:
array
Title:
Show Source
List<ApiEntityProgramBudgetStatusTransitionHistory>
-
Array of:
object ApiEntityProgramBudgetStatusTransitionHistory
Title:
ApiEntityProgramBudgetStatusTransitionHistory
Nested Schema : ApiEntityProgramBudgetStatusTransitionHistory
Type:
object
Title:
Show Source
ApiEntityProgramBudgetStatusTransitionHistory
-
comment: string
Minimum Length:
0
Maximum Length:4000
Comments included by the user who changed the status of the record. -
date: string
(date-time)
Read Only:
true
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. -
programBudgetId: integer
(int64)
The ID of the program budget.
-
programBudgetStatusTransitionHistoryId: integer
(int64)
A unique identifier for the change.
-
statusTransitionType: string
Read Only:
true
Allowed Values:[ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "REJECT", "DRAFT" ]
The date the status of the record was changed. -
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated. -
userId: integer
(int64)
Read Only:
true
The user who changed the status of the record. -
userName: string
Read Only:
true
Maximum Length:255
The username of the user who changed the status of the record.
204 Response
Successful operation with no content.
404 Response
The requested program does not exist, or you do not have access to it.