Jump to

• Request
• Response

View Program Budget Change Status Transition History Records by Program Budget Change

get

/api/restapi/programBudgetChange/{programBudgetChangeId}/statusTransitionHistory

This endpoint returns status transition history records of a program budget change that meet the following requirements:

• The object is associated with a program budget change with an ID value that matches the value of the {programBudgetChangeId} path parameter.

Program Budget changes represent modifications or adjustments to program budgets.

Request

Path Parameters

• programBudgetChangeId(required): integer(int64)
  The system-generated identifier of a program budget change.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityProgramBudgetChangeStatusTransitionHistory>

Type: array

Title: List<ApiEntityProgramBudgetChangeStatusTransitionHistory>

Show Source

• Array of: object ApiEntityProgramBudgetChangeStatusTransitionHistory
  Title: ApiEntityProgramBudgetChangeStatusTransitionHistory

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

Nested Schema : ApiEntityProgramBudgetChangeStatusTransitionHistory

Type: object

Title: ApiEntityProgramBudgetChangeStatusTransitionHistory

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 4000

  Comments included by the user who changed the status of the record.
• date: string (date-time)
  The date the status of the record was changed.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• programBudgetChangeId: integer (int64)
  The system-generated identifier of a budget change.
• programBudgetChangeStatusTransitionHistoryId: integer (int64)
  The system-generated identifier of a budget change status transition history.
• statusTransitionType: string
  Allowed Values: [ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "REJECT", "DRAFT" ]

  The type of change made to the record.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• userId: integer (int64)
  The user who changed the status of the record.
• userName: string
  Maximum Length: 255

  The name of a user associated with the status transition history.

{
    "title":"ApiEntityProgramBudgetChangeStatusTransitionHistory",
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "comment":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Comments included by the user who changed the status of the record.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "date":{
            "type":"string",
            "description":"The date the status of the record was changed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userId":{
            "type":"integer",
            "description":"The user who changed the status of the record.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "userName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of a user associated with the status transition history.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetChangeId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetChangeStatusTransitionHistoryId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget change status transition history.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "statusTransitionType":{
            "type":"string",
            "description":"The type of change made to the record.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SUBMIT",
                "APPROVE",
                "WITHDRAW_APPROVAL",
                "REJECT",
                "DRAFT"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested status transition history record does not exist, or you do not have access to it.

Back to Top