Jump to

• Request
• Response

Batch Create Program Budgets

post

/api/restapi/programBudget/batch

This endpoint creates one or more program budgets with Status values of DRAFT. If the program budgets already exist, they are directly returned.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityProgramBudgetInput>

Type: array

Title: List<ApiEntityProgramBudgetInput>

Show Source

• Array of: object ApiEntityProgramBudgetInput
  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

{
    "title":"List<ApiEntityProgramBudgetInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramBudgetInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested 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

• approveByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The user who approved the budget.
• approveByUserName: string
  Read 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: string
  Read 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: string
  Read 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: string
  Read 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: string
  Read 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.

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

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : List<ApiEntityProgramBudget>

Type: array

Title: List<ApiEntityProgramBudget>

Show Source

• Array of: object ApiEntityProgramBudget
  Title: ApiEntityProgramBudget

{
    "title":"List<ApiEntityProgramBudget>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramBudget",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested 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"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "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"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for a program.",
            "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"
            ]
        },
        "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"
            ]
        },
        "approveByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"The username of the user who approves the budget.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetStatus":{
            "type":"string",
            "description":"The status of the budget.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "PENDING",
                "REJECTED",
                "APPROVED"
            ]
        },
        "lastModifiedById":{
            "type":"integer",
            "description":"The user who last made changes to the item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectByUserId":{
            "type":"integer",
            "description":"The user who rejected the budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"The username of the user who rejected the budget.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "rejectDate":{
            "type":"string",
            "description":"The date the budget was rejected.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "submitByUserId":{
            "type":"integer",
            "description":"The user who submitted the budget for review.",
            "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"
            ]
        },
        "submitDate":{
            "type":"string",
            "description":"The date the budget was submitted for review.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "withdrawApprovalDate":{
            "type":"string",
            "description":"The date the approval of the budget is withdrawn.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "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