Create a Program Budget
post
/api/restapi/programBudget
This endpoint creates a program budget with a Status value of DRAFT. If the program budget already exists, it is directly returned.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityProgramBudgetInput
Type:
object
Title:
ApiEntityProgramBudgetInput
This entity represents a ProgramBudget object, a unique ProgramBudget object can be identified by the following combinations of the fields.
Show Source
- programId
- programCode, workspaceId
- programCode, workspaceCode
-
approveByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The user who approved the budget. -
approveByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.The username of the user who approves the budget. -
approveDate: string(date-time)Read Only:true
Deprecated. As of 23.11.The date the project budget was approved. -
budgetStatus: stringRead Only:true
Allowed Values:[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
Deprecated. As of 23.11.The status of the budget. -
lastModifiedById: integer(int64)Read Only:true
Deprecated. As of 23.11.The user who last made changes to the item. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
programBudgetId: integer(int64)Read Only:true
Deprecated. As of 23.11.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)Read Only:true
Deprecated. As of 23.11.The user who rejected the budget. -
rejectByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.The username of the user who rejected the budget. -
rejectDate: string(date-time)Read Only:true
Deprecated. As of 23.11.The date the budget was rejected. -
submitByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The user who submitted the budget for review. -
submitByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.The username of the user who submitted the budget for review. -
submitDate: string(date-time)Read Only:true
Deprecated. As of 23.11.The date the budget was submitted for review. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
withdrawApprovalByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The user who withdrew the approved budget. -
withdrawApprovalByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.The The username of the user who withdrew the approved budget. -
withdrawApprovalDate: string(date-time)Read Only:true
Deprecated. As of 23.11.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.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
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.
400 Response
Invalid input for the Program Budget service. Verify the request contains valid data, then resubmit the request.