Jump to

• Request
• Response

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

Request Body - 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.

• programId
• programCode, workspaceId
• programCode, workspaceCode

Show Source

• 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.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApiEntityProgramBudgetInput",
    "type":"object",
    "properties":{
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for a program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProgramBudget object, a unique ProgramBudget object can be identified by the following combinations of the fields.<ul><li>programId</li><li>programCode, workspaceId</li><li>programCode, workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Create a Program Budget.

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityProgramBudget

Type: object

Title: ApiEntityProgramBudget

Show Source

• 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.

{
    "title":"ApiEntityProgramBudget",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "approveDate":{
            "type":"string",
            "description":"The date the project budget was approved.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetId":{
            "type":"integer",
            "description":"The ID of the program budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approveByUserId":{
            "type":"integer",
            "description":"The user who approved the budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetStatus":{
            "type":"string",
            "description":"The status of the budget.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "PENDING",
                "REJECTED",
                "APPROVED"
            ]
        },
        "submitDate":{
            "type":"string",
            "description":"The date the budget was submitted for review.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "submitByUserId":{
            "type":"integer",
            "description":"The user who submitted the budget for review.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectDate":{
            "type":"string",
            "description":"The date the budget was rejected.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "rejectByUserId":{
            "type":"integer",
            "description":"The user who rejected the budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "rejectByUserName":{
            "maxLength":255,
            "type":"string",
            "description":"The username of the user who rejected the budget.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "withdrawApprovalByUserId":{
            "type":"integer",
            "description":"The user who withdrew the approved budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "withdrawApprovalByUserName":{
            "maxLength":255,
            "type":"string",
            "description":"The The username of the user who withdrew the approved budget.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "approveByUserName":{
            "maxLength":255,
            "type":"string",
            "description":"The username of the user who approves the budget.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lastModifiedById":{
            "type":"integer",
            "description":"The user who last made changes to the item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "submitByUserName":{
            "maxLength":255,
            "type":"string",
            "description":"The username of the user who submitted the budget for review.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "withdrawApprovalDate":{
            "type":"string",
            "description":"The date the approval of the budget is withdrawn.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for a program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Program Budget service. Verify the request contains valid data, then resubmit the request.

Back to Top