Create award funding
post
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFunding
Request
Path Parameters
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AwardFundingId: integer
(int64)
Title:
Award Funding ID
Unique identifier of the award funding. -
AwardFundingSourceId(required): integer
(int64)
Title:
Award Funding Source ID
Unique identifier of the award funding source. -
AwardId(required): integer
(int64)
Title:
Award ID
Unique identifier of the award. -
AwardProjectFunding: array
Award Project Fundings
Title:
Award Project Fundings
The Award Project Fundings resource is used to view funding allocation attributes for the award project. -
BudgetPeriod: string
Name of the budget period for the award.
-
BudgetPeriodId(required): integer
(int64)
Title:
Budget Period ID
Unique identifier of the award budget period. -
DirectFundingAmount(required): number
Title:
Direct Funding Amount
Total funding amount granted for the award. -
FundingIssueDate(required): string
(date)
Title:
Date
Date when the funding was issued. -
FundingIssueDescription: string
Title:
Description
Maximum Length:240
Description of the funding issue. -
FundingIssueNumber(required): string
Title:
Number
Maximum Length:200
Number of the funding issue. -
FundingIssueType(required): string
Title:
Type
Maximum Length:30
Type code of funding issued, for example BASE or SUPPLEMENT. -
FundingIssueTypeName: string
Title:
Award Funding Issue Type
Maximum Length:80
Type of funding issued, for example Base or Supplement. -
FundingSourceId(required): integer
(int64)
Title:
Funding Source ID
Unique identifier of the funding source. -
FundingSourceName: string
Title:
Funding Source Name
Maximum Length:360
Name of the funding source. -
FundingSourceNumber: string
Title:
Funding Source Number
Maximum Length:50
Number of the funding source, entered by the user. -
IndirectFundingAmount: number
Title:
Indirect Funding Amount
Burden amount granted by the sponsor as part of funding amount.
Nested Schema : Award Project Fundings
Type:
array
Title:
Award Project Fundings
The Award Project Fundings resource is used to view funding allocation attributes for the award project.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
Unique identifier of the award. -
AwardProjectFundingId: integer
(int64)
Title:
Award Project Funding ID
Unique identifier of the award project funding allocation. -
AwardProjectLinkId: integer
(int64)
Title:
Award Project Link ID
Unique identifier of the award project. -
FundingAmount: number
Title:
Funding Amount
Funding amount allocated to the award project. -
ProjectId: integer
Title:
Project ID
Unique identifier of the award project. -
ProjectName: string
Title:
Project Name
Name of the project to which the funding is allocated. -
ProjectNumber: string
Title:
Project Number
Number of the project to which the funding is allocated.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : awards-AwardFunding-item-response
Type:
Show Source
object
-
AwardFundingId: integer
(int64)
Title:
Award Funding ID
Unique identifier of the award funding. -
AwardFundingSourceId: integer
(int64)
Title:
Award Funding Source ID
Unique identifier of the award funding source. -
AwardId: integer
(int64)
Title:
Award ID
Unique identifier of the award. -
AwardProjectFunding: array
Award Project Fundings
Title:
Award Project Fundings
The Award Project Fundings resource is used to view funding allocation attributes for the award project. -
BudgetPeriod: string
Name of the budget period for the award.
-
BudgetPeriodId: integer
(int64)
Title:
Budget Period ID
Unique identifier of the award budget period. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award funding. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award funding was created. -
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:15
Currency code representing the award currency. The currency code is a three-letter ISO code associated with a currency. -
DirectFundingAmount: number
Title:
Direct Funding Amount
Total funding amount granted for the award. -
FundingIssueDate: string
(date)
Title:
Date
Date when the funding was issued. -
FundingIssueDescription: string
Title:
Description
Maximum Length:240
Description of the funding issue. -
FundingIssueNumber: string
Title:
Number
Maximum Length:200
Number of the funding issue. -
FundingIssueType: string
Title:
Type
Maximum Length:30
Type code of funding issued, for example BASE or SUPPLEMENT. -
FundingIssueTypeName: string
Title:
Award Funding Issue Type
Maximum Length:80
Type of funding issued, for example Base or Supplement. -
FundingSourceId: integer
(int64)
Title:
Funding Source ID
Unique identifier of the funding source. -
FundingSourceName: string
Title:
Funding Source Name
Maximum Length:360
Name of the funding source. -
FundingSourceNumber: string
Title:
Funding Source Number
Maximum Length:50
Number of the funding source, entered by the user. -
IndirectFundingAmount: number
Title:
Indirect Funding Amount
Burden amount granted by the sponsor as part of funding amount. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award funding was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award funding. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Award Project Fundings
Type:
array
Title:
Award Project Fundings
The Award Project Fundings resource is used to view funding allocation attributes for the award project.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardFunding-AwardProjectFunding-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
Unique identifier of the award. -
AwardProjectFundingId: integer
(int64)
Title:
Award Project Funding ID
Unique identifier of the award project funding allocation. -
AwardProjectLinkId: integer
(int64)
Title:
Award Project Link ID
Unique identifier of the award project. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award project funding allocation. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award project funding allocation was created. -
CurrencyCode: string
Title:
Currency
Read Only:true
Currency code representing the award currency. The currency code is a three-letter ISO code associated with a currency. -
FundingAmount: number
Title:
Funding Amount
Funding amount allocated to the award project. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award project funding allocation was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award project funding allocation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectId: integer
Title:
Project ID
Unique identifier of the award project. -
ProjectName: string
Title:
Project Name
Name of the project to which the funding is allocated. -
ProjectNumber: string
Title:
Project Number
Number of the project to which the funding is allocated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- AwardProjectFunding
-
Parameters:
- AwardFundingId:
$request.path.AwardFundingId
- AwardId:
$request.path.AwardId
The Award Project Fundings resource is used to view funding allocation attributes for the award project. - AwardFundingId: