Jump to

• Request
• Response

Update an award budget period

patch

/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardBudgetPeriod/{AwardBudgetPeriodId}

Request

Path Parameters

• AwardBudgetPeriodId(required): integer(int64)
  The unique identifier of the award budget period.
• AwardId(required): integer(int64)
  Unique identifier of the award.

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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AwardId: integer (int64)
  Title: Award ID

  The unique internal identifier of the award.
• BudgetPeriod: string
  Title: Name

  Maximum Length: 15

  The time interval assigned to the award for which the budget, actual, commitment, and available amount are shown.
• EndDate: string (date)
  Title: End Date

  End date of the budget period for the award.
• StartDate: string (date)
  Title: Start Date

  Start date of the budget period for the award.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the budget period for the award.",
            "format":"date",
            "nullable":false
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"The unique internal identifier of the award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BudgetPeriod":{
            "title":"Name",
            "maxLength":"15",
            "type":"string",
            "description":"The time interval assigned to the award for which the budget, actual, commitment, and available amount are shown.",
            "nullable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of the budget period for the award.",
            "format":"date",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : awards-AwardBudgetPeriod-item-response

Type: object

Show Source

• AwardBudgetPeriodId: integer (int64)
  Title: Budget Period ID

  The unique identifier of the award budget period.
• AwardId: integer (int64)
  Title: Award ID

  The unique internal identifier of the award.
• BudgetPeriod: string
  Title: Name

  Maximum Length: 15

  The time interval assigned to the award for which the budget, actual, commitment, and available amount are shown.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that created the award budget period.
• CreationDate: string (date-time)
  Read Only: true

  The date when the award budget period was created.
• EndDate: string (date)
  Title: End Date

  End date of the budget period for the award.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the award budget period was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the award budget period.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StartDate: string (date)
  Title: Start Date

  Start date of the budget period for the award.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that last updated the award budget period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the budget period for the award.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the award budget period was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that created the award budget period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardBudgetPeriodId":{
            "title":"Budget Period ID",
            "type":"integer",
            "description":"The unique identifier of the award budget period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"The unique internal identifier of the award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BudgetPeriod":{
            "title":"Name",
            "maxLength":"15",
            "type":"string",
            "description":"The time interval assigned to the award for which the budget, actual, commitment, and available amount are shown.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of the budget period for the award.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the award budget period was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top