Jump to

• Request
• Response
• Examples

Update dates and budget periods for an award.

post

/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates

Use this action to update the award dates, including the preaward date and the close date, and the budget period dates. This action will update the contract and control budget with the new dates, as applicable.

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• AwardAttributes: object AwardAttributes
  Additional Properties Allowed: additionalProperties

  The array of award attributes such as Award ID, Award Number, Award Name, Preaward Date and Close Date.
• BudgetPeriods: array BudgetPeriods
  The array of budget period attributes such as Budget Period Name, Budget Period Start Date and Budget Period End Date.

{
    "type":"object",
    "properties":{
        "AwardAttributes":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The array of award attributes such as Award ID, Award Number, Award Name, Preaward Date and Close Date.",
            "nullable":true
        },
        "BudgetPeriods":{
            "type":"array",
            "description":"The array of budget period attributes such as Budget Period Name, Budget Period Start Date and Budget Period End Date.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : AwardAttributes

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The array of award attributes such as Award ID, Award Number, Award Name, Preaward Date and Close Date.",
    "nullable":true
}

The array of award attributes such as Award ID, Award Number, Award Name, Preaward Date and Close Date.

Nested Schema : BudgetPeriods

Type: array

The array of budget period attributes such as Budget Period Name, Budget Period Start Date and Budget Period End Date.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"The array of budget period attributes such as Budget Period Name, Budget Period Start Date and Budget Period End Date.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  The updateAwardDates action returns a message if the updates were done successfully or a process was submitted for the date updates.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"The updateAwardDates action returns a message if the updates were done successfully or a process was submitted for the date updates."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"The updateAwardDates action returns a message if the updates were done successfully or a process was submitted for the date updates."
}

The updateAwardDates action returns a message if the updates were done successfully or a process was submitted for the date updates.

Back to Top

Examples

Example 1

The following example shows how to add a new budget period within the award start and end dates for the award without any control budgets by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.vision.adf.action+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{

    "AwardAttributes": {

        "AwardNumber": "UpdateAwardDates_Examples"

    },

    "BudgetPeriods": [

        {

            "BudgetPeriodId": 300100547890042,

            "BudgetPeriod": "BP-1",

            "StartDate": "2014-10-01",

            "EndDate": "2015-09-30"

        },

        {

            "BudgetPeriod": "BP-2",

            "StartDate": "2015-10-01",

            "EndDate": "2019-09-30"

        }

    ]

}

Response Body Example

The following shows an example of the response body in JSON format.

{
"result": {
"Return": "The award dates and budget period dates are updated successfully. (GMS-2145276)"
}
}

Example 2

The following example shows how to add a new budget period within the award start and end dates for award with control budgets by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.vision.adf.action+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
    "AwardAttributes": {
        "AwardNumber": "PROCESS_CATEG_A3"
    },
    "BudgetPeriods": [
        {
            "BudgetPeriodId": "300100121769222",
            "BudgetPeriod": "YrStartOct-13",
            "EndDate": "2014-03-15"
        },
        {
            "BudgetPeriodId": "300100121769223",
            "BudgetPeriod": "YrStartOct-14",
            "StartDate": "2014-12-16"
        },
        {
            "BudgetPeriod": "Yr14_New",
            "StartDate": "2014-03-16",
            "EndDate": "2014-12-15"
        }
    ]
}

Response Body Example

The following shows an example of the response body in JSON format.

{
"result": {
"Return": "The Update Award Dates in Control Budget and Contract process was submitted. (GMS-2145275)"
}
}

Example 3

The following example shows how to add a new budget period to extend the award end date and close date by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.vision.adf.action+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
    "AwardAttributes": {
        "AwardNumber": "UpdateAwardDates_Examples",
        "CloseDate": "2020-10-30"
    },
    "BudgetPeriods": [
        {
            "BudgetPeriod": "BP-3",
            "StartDate": "2019-10-01",
            "EndDate": "2020-09-30"
        }
    ]
}

Response Body Example

The following shows an example of the response body in JSON format.

{
"result": {
"Return": "The Update Award Dates in Control Budget and Contract process was submitted. (GMS-2145275)"
}
}

Example 4

The following example shows how to retrieve the DateChangeRequestId for an award by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X GET "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards?q=AwardNumber="<Award_Number>"&fields=AwardNumber,DateChangeRequestId" -H 'cache-control: no-cache'

Response Body Example

The following shows an example of the response body in JSON format.

{
"items": [
{
"AwardNumber": "<Award_Number>",
"DateChangeRequestId": <Request_Id>

}

]

}

Example 5

The following example shows how to delete a budget period without changing the award start and end dates for an award without control budgets by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.vision.adf.action+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
    "AwardAttributes": {
        "AwardNumber": "UpdateAwardDates_Examples"
    },
    "BudgetPeriods": [
        {
            "BudgetPeriodId": "300100547968846",
            "DeleteFlag": "Y"
        },
        {
            "BudgetPeriodId": "100100386934521",
            "BudgetPeriod": "BP-3",
            "StartDate": "2015-10-01",
            "EndDate": "2020-09-30"
        }
    ]
}

Response Body Example

The following shows an example of the response body in JSON format.

{
"result": {
"Return": "The award dates and budget period dates are updated successfully. (GMS-2145276)"
}
}

Example 6

The following example shows how to delete a budget period without changing the award start and end dates for an award having control budgets by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.vision.adf.action+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
    "AwardAttributes": {
        "AwardNumber": "PROCESS_CATEG_A3"
    },
    "BudgetPeriods": [
        {
            "BudgetPeriodId": "300100121769222",
            "BudgetPeriod": "YrStartOct-13",
            "EndDate": "2014-09-30"
        },
        {
            "BudgetPeriodId": "300100121769223",
            "BudgetPeriod": "YrStartOct-14",
            "StartDate": "2014-10-01"
        },
        {
            "BudgetPeriodId": "100100387825131",
            "DeleteFlag": "Y"
        }
    ]
}

Response Body Example

The following shows an example of the response body in JSON format.

{
"result": {
"Return": "The Update Award Dates in Control Budget and Contract process was submitted. (GMS-2145275)"
}
}

Example 7

The following example shows how to delete a budget period to advance the start date of the award by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.vision.adf.action+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
    "AwardAttributes": {
        "AwardNumber": "UpdateAwardDates_Examples"
    },
    "BudgetPeriods": [
        {
            "BudgetPeriodId": "300100547890042",
            "DeleteFlag": "Y"
        }
    ]
}

Response Body Example

The following shows an example of the response body in JSON format.

{
"result": {
"Return": "The Update Award Dates in Control Budget and Contract process was submitted. (GMS-2145275)"
}
}

Example 8

The following example shows how to rename a budget period for an award without control budgets by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.vision.adf.action+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
    "AwardAttributes": {
        "AwardNumber": "UpdateAwardDates_Examples"
    },
    "BudgetPeriods": [
        {
            "BudgetPeriodId": "100100386934521",
            "BudgetPeriod": "BP-1_new"
        }
    ]
}

Response Body Example

The following shows an example of the response body in JSON format.

{
"result": {
"Return": "The award dates and budget period dates are updated successfully. (GMS-2145276)"
}
}

Example 9

The following example shows how to advance the start date of the award by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.vision.adf.action+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
    "AwardAttributes": {
        "AwardNumber": "UpdateAwardDates_Examples"
    },
    "BudgetPeriods": [
        {
            "BudgetPeriodId": "100100386934521",
            "StartDate": "2014-10-01"
        }
    ]
}

Response Body Example

The following shows an example of the response body in JSON format.

{
"result": {
"Return": "The Update Award Dates in Control Budget and Contract process was submitted. (GMS-2145275)"
}
}

Example 10

The following example shows how to provide a pre award date for an award by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.vision.adf.action+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
    "AwardAttributes": {
        "AwardNumber": "UpdateAwardDates_Examples",
        "PreAwardDate": "2014-01-01"
    }
}

Response Body Example

The following shows an example of the response body in JSON format.

{
"result": {
"Return": "The award dates and budget period dates are updated successfully. (GMS-2145276)"
}
}

Example 11

The following example shows how to provide a pre award date for an award without budgetary control by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.vision.adf.action+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
    "AwardAttributes": {
        "AwardNumber": "PROCESS_CATEG_A2",
        "PreAwardDate": "2013-01-01"
    }
}

Response Body Example

The following shows an example of the response body in JSON format.

{
"result": {
"Return": "The Update Award Dates in Control Budget and Contract process was submitted. (GMS-2145275)"
}
}

Example 12

The following example shows how to retreive the errors for failed date change by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X GET "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/<award_id>/child/AwardError" -H 'cache-control: no-cache'

Response Body Example

The following shows an example of the response body in JSON format.

{
"items": [
{
"AwardId": 300100121425620,
"AwardErrorId": 100100386953162,
"ErrorType": "E",
"ErrorCode": "PJO_XCC_BPEDDATE_UPDERR",
"MessageText": "You can't update the end date of the budget period because transactions exist.",
"CreatedBy": "Alice.Parker",
"CreationDate": "2021-11-01T10:02:49+00:00",
"LastUpdateDate": "2021-11-01T10:02:49+00:00",
"LastUpdatedBy": "Alice.Parker",
"MessageUserDetails": "You can't update the 2014-08-15 end date to 2013-12-15 for the YrStartOct-13 budget period because transactions exist as of 2014-02-02 transaction date. You can provide an end date that's on or after the transaction date for that budget period."

}

]

}

Example 13

The following example shows how to change the budget period dates for an award with budgetary controls by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.vision.adf.action+json" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
    "AwardAttributes": {
        "AwardNumber": "PROCESS_CATEG_A2"
    },
    "BudgetPeriods": [
        {
            "BudgetPeriodId": "300100121449505",
            "EndDate": "2013-12-15"
        },
        {
            "BudgetPeriodId": "300100121449506",
            "StartDate": "2013-12-16"
        }
    ]
}

Response Body Example

The following shows an example of the response body in JSON format.

{
"result": {
"Return": "The Update Award Dates in Control Budget and Contract process was submitted. (GMS-2145275)"
}
}

Example 14

The following example shows how to update the award and budget period dates for multiple awards using batch request by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -H "Content-Type: application/vnd.vision.adf.batch+json" -H "REST-Framework-Version: 5" -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{

   "parts": [
        {
            "id": "payload1",
            "path": "/awards/action/updateAwardDates",
            "operation": "invoke",
            "payload": {
                "AwardAttributes": {
                    "AwardNumber": "PROCESS_CATEG_A3",
                    "PreAwardDate": "2013-01-01",
                    "CloseDate": "2019-12-30"
                },
                "BudgetPeriods": [
                    {
                        "BudgetPeriodId": "300100121769222",
                        "BudgetPeriod": "YrStartOct-13",
                        "EndDate": "2014-10-15"
                    },
                    {
                        "BudgetPeriodId": "300100121769223",
                        "BudgetPeriod": "YrStartOct-14",
                        "StartDate": "2014-10-16"
                    }
                ]
            }
        },
        {
            "id": "payload2",
            "path": "/awards/action/updateAwardDates",
            "operation": "invoke",
            "payload": {
                "AwardAttributes": {
                    "AwardNumber": "UpdateAwardDates_Examples"
                },
                "BudgetPeriods": [
                    {
                        "BudgetPeriodId": "100100386934521",
                        "BudgetPeriod": "BP-1",
                        "StartDate": "2014-10-01",
                        "EndDate": "2016-09-15"
                    },
                    {
                        "BudgetPeriod": "BP-2",
                        "StartDate": "2016-09-16",
                        "EndDate": "2020-09-30"
                    }
                ]
            }
        }
    ]
}

Response Body Example

The following shows an example of the response body in JSON format.

{
"parts": [
{
"id": "payload1",
"path": "https://hostname:443/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates",
"operation": "invoke",
"payload": {
"result": {
"Return": "The Update Award Dates in Control Budget and Contract process was submitted. (GMS-2145275)"
}
}
},
{
"id": "payload2",
"path": "https://hostname:443/fscmRestApi/resources/11.13.18.05/awards/action/updateAwardDates",
"operation": "invoke",
"payload": {
"result": {
"Return": "The award dates and budget period dates are updated successfully. (GMS-2145276)"
}
}
}
]
}

Back to Top