Jump to

• Request
• Response

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: string
  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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{ "required":[ "AwardFundingSourceId", "AwardId", "BudgetPeriodId", "DirectFundingAmount", "FundingIssueDate", "FundingIssueNumber", "FundingIssueType", "FundingSourceId" ], "type":"object", "properties":{ "AwardFundingSourceId":{ "title":"Award Funding Source ID", "type":"integer", "description":"Unique identifier of the award funding source.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 } }, "DirectFundingAmount":{ "title":"Direct Funding Amount", "type":"number", "description":"Total funding amount granted for the award.", "nullable":false }, "IndirectFundingAmount":{ "title":"Indirect Funding Amount", "type":"number", "description":"Burden amount granted by the sponsor as part of funding amount.", "nullable":true }, "AwardFundingId":{ "title":"Award Funding ID", "type":"integer", "description":"Unique identifier of the award funding.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" } }, "AwardId":{ "title":"Award ID", "type":"integer", "description":"Unique identifier of the award.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 } }, "BudgetPeriodId":{ "title":"Budget Period ID", "type":"integer", "description":"Unique identifier of the award budget period.", "format":"int64", "nullable":false, "x-hints":{ "controlType":"combo_lov", "precision":18 } }, "FundingIssueDescription":{ "title":"Description", "maxLength":240, "type":"string", "description":"Description of the funding issue.", "nullable":true }, "FundingIssueDate":{ "title":"Date", "type":"string", "description":"Date when the funding was issued.", "format":"date", "nullable":false }, "AwardProjectFunding":{ "title":"Award Project Fundings", "type":"array", "description":"The Award Project Fundings resource is used to view funding allocation attributes for the award project.", "items":{ "$ref":"#/components/schemas/awards-AwardFunding-AwardProjectFunding-item-post-request" } }, "FundingSourceName":{ "title":"Funding Source Name", "maxLength":360, "type":"string", "description":"Name of the funding source.", "nullable":true, "x-hints":{ "controlType":"choice" } }, "FundingSourceId":{ "title":"Funding Source ID", "type":"integer", "description":"Unique identifier of the funding source.", "format":"int64", "nullable":false, "x-hints":{ "controlType":"combo_lov", "precision":18 } }, "FundingSourceNumber":{ "title":"Funding Source Number", "maxLength":50, "type":"string", "description":"Number of the funding source, entered by the user.", "nullable":true, "x-hints":{ "controlType":"choice" } }, "FundingIssueNumber":{ "title":"Number", "maxLength":200, "type":"string", "description":"Number of the funding issue.", "nullable":false }, "BudgetPeriod":{ "type":"string", "description":"Name of the budget period for the award.", "nullable":true }, "FundingIssueTypeName":{ "title":"Award Funding Issue Type", "maxLength":80, "type":"string", "description":"Type of funding issued, for example Base or Supplement.", "nullable":false, "x-hints":{ "controlType":"choice" } }, "FundingIssueType":{ "title":"Type", "maxLength":30, "type":"string", "description":"Type code of funding issued, for example BASE or SUPPLEMENT.", "nullable":false, "x-hints":{ "controlType":"choice" } } } }

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

• Array of: object schema

{ "title":"Award Project Fundings", "type":"array", "description":"The Award Project Fundings resource is used to view funding allocation attributes for the award project.", "items":{ "$ref":"#/components/schemas/awards-AwardFunding-AwardProjectFunding-item-post-request" } }

Nested Schema : schema

Type: object

Show Source

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

{ "type":"object", "properties":{ "AwardProjectLinkId":{ "title":"Award Project Link ID", "type":"integer", "description":"Unique identifier of the award project.", "format":"int64", "nullable":false, "x-hints":{ "controlType":"combo_lov", "precision":18 } }, "ProjectName":{ "title":"Project Name", "type":"string", "description":"Name of the project to which the funding is allocated.", "nullable":true, "x-hints":{ "controlType":"combo_lov" } }, "ProjectNumber":{ "title":"Project Number", "type":"string", "description":"Number of the project to which the funding is allocated.", "nullable":true, "x-hints":{ "controlType":"combo_lov" } }, "FundingAmount":{ "title":"Funding Amount", "type":"number", "description":"Funding amount allocated to the award project.", "nullable":false }, "ProjectId":{ "title":"Project ID", "type":"integer", "description":"Unique identifier of the award project.", "nullable":true, "x-queryable":false, "x-hints":{ "controlType":"combo_lov" } }, "AwardId":{ "title":"Award ID", "type":"integer", "description":"Unique identifier of the award.", "format":"int64", "nullable":true, "x-hints":{ "precision":18 } }, "AwardProjectFundingId":{ "title":"Award Project Funding ID", "type":"integer", "description":"Unique identifier of the award project funding allocation.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" } } } }

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-AwardFunding-item-response

Type: object

Show Source

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

{ "type":"object", "properties":{ "LastUpdatedBy":{ "maxLength":64, "type":"string", "description":"The user that last updated the award funding.", "nullable":false, "readOnly":true, "x-queryable":true }, "CreationDate":{ "type":"string", "description":"The date when the award funding was created.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true }, "AwardFundingSourceId":{ "title":"Award Funding Source ID", "type":"integer", "description":"Unique identifier of the award funding source.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "CreatedBy":{ "maxLength":64, "type":"string", "description":"The user that created the award funding.", "nullable":false, "readOnly":true, "x-queryable":true }, "DirectFundingAmount":{ "title":"Direct Funding Amount", "type":"number", "description":"Total funding amount granted for the award.", "nullable":false, "x-queryable":true }, "IndirectFundingAmount":{ "title":"Indirect Funding Amount", "type":"number", "description":"Burden amount granted by the sponsor as part of funding amount.", "nullable":true, "x-queryable":true }, "AwardFundingId":{ "title":"Award Funding ID", "type":"integer", "description":"Unique identifier of the award funding.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true }, "AwardId":{ "title":"Award ID", "type":"integer", "description":"Unique identifier of the award.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "BudgetPeriodId":{ "title":"Budget Period ID", "type":"integer", "description":"Unique identifier of the award budget period.", "format":"int64", "nullable":false, "x-hints":{ "controlType":"combo_lov", "precision":18 }, "x-queryable":true }, "FundingIssueDescription":{ "title":"Description", "maxLength":240, "type":"string", "description":"Description of the funding issue.", "nullable":true, "x-queryable":true }, "FundingIssueDate":{ "title":"Date", "type":"string", "description":"Date when the funding was issued.", "format":"date", "nullable":false, "x-queryable":true }, "AwardProjectFunding":{ "title":"Award Project Fundings", "type":"array", "description":"The Award Project Fundings resource is used to view funding allocation attributes for the award project.", "items":{ "$ref":"#/components/schemas/awards-AwardFunding-AwardProjectFunding-item-response" } }, "FundingSourceName":{ "title":"Funding Source Name", "maxLength":360, "type":"string", "description":"Name of the funding source.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "CurrencyCode":{ "title":"Currency", "maxLength":15, "type":"string", "description":"Currency code representing the award currency. The currency code is a three-letter ISO code associated with a currency.", "nullable":false, "readOnly":true, "x-queryable":true }, "FundingSourceId":{ "title":"Funding Source ID", "type":"integer", "description":"Unique identifier of the funding source.", "format":"int64", "nullable":false, "x-hints":{ "controlType":"combo_lov", "precision":18 }, "x-queryable":true }, "FundingSourceNumber":{ "title":"Funding Source Number", "maxLength":50, "type":"string", "description":"Number of the funding source, entered by the user.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "FundingIssueNumber":{ "title":"Number", "maxLength":200, "type":"string", "description":"Number of the funding issue.", "nullable":false, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "BudgetPeriod":{ "type":"string", "description":"Name of the budget period for the award.", "nullable":true, "x-queryable":true }, "FundingIssueTypeName":{ "title":"Award Funding Issue Type", "maxLength":80, "type":"string", "description":"Type of funding issued, for example Base or Supplement.", "nullable":false, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "LastUpdateDate":{ "type":"string", "description":"The date when the award funding was last updated.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true }, "FundingIssueType":{ "title":"Type", "maxLength":30, "type":"string", "description":"Type code of funding issued, for example BASE or SUPPLEMENT.", "nullable":false, "x-hints":{ "controlType":"choice" }, "x-queryable":true } } }

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

• Array of: object awards-AwardFunding-AwardProjectFunding-item-response

{ "title":"Award Project Fundings", "type":"array", "description":"The Award Project Fundings resource is used to view funding allocation attributes for the award project.", "items":{ "$ref":"#/components/schemas/awards-AwardFunding-AwardProjectFunding-item-response" } }

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 : awards-AwardFunding-AwardProjectFunding-item-response

Type: object

Show Source

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

{ "type":"object", "properties":{ "LastUpdatedBy":{ "maxLength":64, "type":"string", "description":"The user that last updated the award project funding allocation.", "nullable":false, "readOnly":true, "x-queryable":true }, "CreationDate":{ "type":"string", "description":"The date when the award project funding allocation was created.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true }, "AwardProjectLinkId":{ "title":"Award Project Link ID", "type":"integer", "description":"Unique identifier of the award project.", "format":"int64", "nullable":false, "x-hints":{ "controlType":"combo_lov", "precision":18 }, "x-queryable":true }, "CreatedBy":{ "maxLength":64, "type":"string", "description":"The user that created the award project funding allocation.", "nullable":false, "readOnly":true, "x-queryable":true }, "ProjectName":{ "title":"Project Name", "type":"string", "description":"Name of the project to which the funding is allocated.", "nullable":true, "x-hints":{ "controlType":"combo_lov" }, "x-queryable":true }, "ProjectNumber":{ "title":"Project Number", "type":"string", "description":"Number of the project to which the funding is allocated.", "nullable":true, "x-hints":{ "controlType":"combo_lov" }, "x-queryable":true }, "ProjectId":{ "title":"Project ID", "type":"integer", "description":"Unique identifier of the award project.", "nullable":true, "x-queryable":false, "x-hints":{ "controlType":"combo_lov" } }, "AwardId":{ "title":"Award ID", "type":"integer", "description":"Unique identifier of the award.", "format":"int64", "nullable":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "CurrencyCode":{ "title":"Currency", "type":"string", "description":"Currency code representing the award currency. The currency code is a three-letter ISO code associated with a currency.", "nullable":true, "readOnly":true, "x-queryable":true }, "FundingAmount":{ "title":"Funding Amount", "type":"number", "description":"Funding amount allocated to the award project.", "nullable":false, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "AwardProjectFundingId":{ "title":"Award Project Funding ID", "type":"integer", "description":"Unique identifier of the award project funding allocation.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true }, "LastUpdateDate":{ "type":"string", "description":"The date when the award project funding allocation 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." } } }

Links

AwardProjectFunding

Operation: /fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFunding/{AwardFundingId}/child/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.

Back to Top