View a Program Budget by Program
get
/api/restapi/programBudget/program/{programId}
This endpoint returns a program budget 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 : ApiEntityProgramBudget
Type:
object
Title:
Show Source
ApiEntityProgramBudget
-
approveByUserId: integer
(int64)
The user who approved the budget.
-
approveByUserName: string
Maximum Length:
255
The username of the user who approves the budget. -
approveDate: string
(date-time)
The date the project budget was approved.
-
budgetStatus: string
Allowed Values:
[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
The status of the budget. -
lastModifiedById: integer
(int64)
The user who last made changes to the item.
-
link: string
(url)
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.
-
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for a program.
-
rejectByUserId: integer
(int64)
The user who rejected the budget.
-
rejectByUserName: string
Maximum Length:
255
The username of the user who rejected the budget. -
rejectDate: string
(date-time)
The date the budget was rejected.
-
submitByUserId: integer
(int64)
The user who submitted the budget for review.
-
submitByUserName: string
Maximum Length:
255
The username of the user who submitted the budget for review. -
submitDate: string
(date-time)
The date the budget was submitted for review.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
withdrawApprovalByUserId: integer
(int64)
The user who withdrew the approved budget.
-
withdrawApprovalByUserName: string
Maximum Length:
255
The The username of the user who withdrew the approved budget. -
withdrawApprovalDate: string
(date-time)
The date the approval of the budget is withdrawn.
-
workspaceCode: string
Maximum Length:
60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier of a workspace.
404 Response
The requested program budget does not exist, or you do not have access to it.