Jump to

• Request
• Response

Change a Program Budget Transfer Status

put

/api/restapi/programBudgetTransfer/{programBudgetTransferId}/changeProgramBudgetTransferStatus

Send a request to this end point to modify the status of a program budget transfer.

Request

Path Parameters

• programBudgetTransferId(required): integer(int64)
  The system-generated identifier of a budget transfer.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityStatusTransition

Type: object

Title: ApiEntityStatusTransition

Show Source

• budgetStatus: string
  Allowed Values: [ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]

  The current status of a budget.
• comment: string
  Maximum Length: 4000

  Comments included by the user who modified the budget.
• userNames: array userNames
  The users associated with the project budget.

{
    "title":"ApiEntityStatusTransition",
    "type":"object",
    "properties":{
        "comment":{
            "maxLength":"4000",
            "type":"string",
            "description":"Comments included by the user who modified the budget.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetStatus":{
            "type":"string",
            "description":"The current status of a budget.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "PENDING",
                "REJECTED",
                "APPROVED"
            ]
        },
        "userNames":{
            "type":"array",
            "description":"The users associated with the project budget.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : userNames

Type: array

The users associated with the project budget.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The users associated with the project budget.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

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

404 Response

The requested program budget transfer does not exist, or you do not have access to it.

Back to Top