Create an award funding pattern
post
/fscmRestApi/resources/11.13.18.05/awardFundingPatterns
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.
-
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
-
distributionSets: array
Award Funding Pattern Distribution Sets
Title:
Award Funding Pattern Distribution Sets
The award funding patterns resource is used to view and manage the values that determine the pattern to use for a project cost based on the expenditure item date and other optional attributes. -
FundingPatternDescription: string
Maximum Length:
2000
The description of the funding pattern. -
FundingPatternEnd: string
(date)
The end date of the funding pattern that combines with the funding pattern start to define the date range for expenditure item dates to be applicable to this pattern.
-
FundingPatternId: integer
(int64)
The unique identifier of the funding pattern.
-
FundingPatternName: string
Maximum Length:
200
The name of the funding pattern. -
FundingPatternStart: string
(date)
The start date of the funding pattern that combines with the funding pattern end to define the date range for expenditure item dates to be applicable to this pattern.
-
FundingPatternStatus: string
The start date of the funding pattern that combines with the funding pattern end to define the date range for expenditure item dates to be applicable to this pattern.
-
FundingPatternStatusCode: string
Maximum Length:
30
Default Value:ORA_GMS_FUND_PATTRN_STS_DRAFT
The start date of the funding pattern that combines with the funding pattern end to define the date range for expenditure item dates to be applicable to this pattern. -
ProjectId: string
Maximum Length:
150
The unique identifier of the project associated to the funding pattern. -
ProjectName: string
Title:
Project Name
Maximum Length:240
The project name associated to the funding pattern. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
The project number associated to the funding pattern. -
TaskId: integer
The unique identifier of the task associated to the funding pattern, if assigned at a task level.
-
TaskName: string
Title:
Task Name
Maximum Length:255
The task name associated to the funding pattern, if assigned at a task level. -
TaskNumber: string
Title:
Task Number
Maximum Length:100
The task number associated to the funding pattern, if assigned at a task level.
Nested Schema : Award Funding Pattern Distribution Sets
Type:
array
Title:
Award Funding Pattern Distribution Sets
The award funding patterns resource is used to view and manage the values that determine the pattern to use for a project cost based on the expenditure item date and other optional attributes.
Show Source
Nested Schema : awardFundingPatterns-distributionSets-item-post-request
Type:
Show Source
object
-
DistributionSetId: integer
(int64)
The unique identifier of the funding pattern distribution set.
-
distributionSetRules: array
Award Funding Pattern Distribution Set Rules
Title:
Award Funding Pattern Distribution Set Rules
The distribution set rules resource is a child of the award funding pattern distribution sets resource to view and manage the rules for a set. -
FundingPatternId(required): integer
(int64)
The unique identifier of the funding pattern.
-
Precedence(required): integer
(int32)
The precedence order of the distribution set that defines the order to apply this set in relation to other sets defined for the funding pattern.
-
SetDescription: string
Maximum Length:
2000
The description of the funding pattern distribution set. -
SetName(required): string
Maximum Length:
200
The name of the funding pattern distribution set.
Nested Schema : Award Funding Pattern Distribution Set Rules
Type:
array
Title:
Award Funding Pattern Distribution Set Rules
The distribution set rules resource is a child of the award funding pattern distribution sets resource to view and manage the rules for a set.
Show Source
Nested Schema : awardFundingPatterns-distributionSets-distributionSetRules-item-post-request
Type:
Show Source
object
-
ContractId: integer
(int64)
Identifier of the contract assigned to the distribution rule, used for Oracle Contract Billing or Oracle Grants Management.
-
ContractName: string
Title:
Contract Name
Maximum Length:300
Name of the contract assigned to the distribution rule, used for Oracle Contract Billing or Oracle Grants Management. -
ContractNumber: string
Title:
Contract Number
Maximum Length:120
Number of the contract assigned to the distribution rule, used for Oracle Contract Billing or Oracle Grants Management. -
DistributionPercentage: number
Title:
Percentage
The percentage the distribution rule applies to project cost amounts and quantities. -
DistributionSetId: integer
(int64)
The unique identifier of the funding pattern distribution set.
-
DistributionSetRuleId: integer
(int64)
The date the record was last updated.
-
DistributionSetRuleNumber: integer
(int32)
The number of the funding pattern distribution set rule.
-
FundingSourceId: integer
(int64)
Identifier of the funding source for the distribution rule.
-
FundingSourceName: string
Title:
Funding Source Name
Maximum Length:360
Funding source name associated to the rule. -
FundingSourceNumber: string
Title:
Funding Source Number
Maximum Length:50
Funding source number associated to the rule.
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 : awardFundingPatterns-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the record was created. -
distributionSets: array
Award Funding Pattern Distribution Sets
Title:
Award Funding Pattern Distribution Sets
The award funding patterns resource is used to view and manage the values that determine the pattern to use for a project cost based on the expenditure item date and other optional attributes. -
FundingPatternDescription: string
Maximum Length:
2000
The description of the funding pattern. -
FundingPatternEnd: string
(date)
The end date of the funding pattern that combines with the funding pattern start to define the date range for expenditure item dates to be applicable to this pattern.
-
FundingPatternId: integer
(int64)
The unique identifier of the funding pattern.
-
FundingPatternName: string
Maximum Length:
200
The name of the funding pattern. -
FundingPatternStart: string
(date)
The start date of the funding pattern that combines with the funding pattern end to define the date range for expenditure item dates to be applicable to this pattern.
-
FundingPatternStatus: string
The start date of the funding pattern that combines with the funding pattern end to define the date range for expenditure item dates to be applicable to this pattern.
-
FundingPatternStatusCode: string
Maximum Length:
30
Default Value:ORA_GMS_FUND_PATTRN_STS_DRAFT
The start date of the funding pattern that combines with the funding pattern end to define the date range for expenditure item dates to be applicable to this pattern. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectId: string
Maximum Length:
150
The unique identifier of the project associated to the funding pattern. -
ProjectName: string
Title:
Project Name
Maximum Length:240
The project name associated to the funding pattern. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
The project number associated to the funding pattern. -
TaskId: integer
The unique identifier of the task associated to the funding pattern, if assigned at a task level.
-
TaskName: string
Title:
Task Name
Maximum Length:255
The task name associated to the funding pattern, if assigned at a task level. -
TaskNumber: string
Title:
Task Number
Maximum Length:100
The task number associated to the funding pattern, if assigned at a task level.
Nested Schema : Award Funding Pattern Distribution Sets
Type:
array
Title:
Award Funding Pattern Distribution Sets
The award funding patterns resource is used to view and manage the values that determine the pattern to use for a project cost based on the expenditure item date and other optional attributes.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awardFundingPatterns-distributionSets-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date the record was created. -
DistributionSetId: integer
(int64)
The unique identifier of the funding pattern distribution set.
-
distributionSetRules: array
Award Funding Pattern Distribution Set Rules
Title:
Award Funding Pattern Distribution Set Rules
The distribution set rules resource is a child of the award funding pattern distribution sets resource to view and manage the rules for a set. -
FundingPatternId: integer
(int64)
The unique identifier of the funding pattern.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Precedence: integer
(int32)
The precedence order of the distribution set that defines the order to apply this set in relation to other sets defined for the funding pattern.
-
SetDescription: string
Maximum Length:
2000
The description of the funding pattern distribution set. -
SetName: string
Maximum Length:
200
The name of the funding pattern distribution set.
Nested Schema : Award Funding Pattern Distribution Set Rules
Type:
array
Title:
Award Funding Pattern Distribution Set Rules
The distribution set rules resource is a child of the award funding pattern distribution sets resource to view and manage the rules for a set.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awardFundingPatterns-distributionSets-distributionSetRules-item-response
Type:
Show Source
object
-
ContractId: integer
(int64)
Identifier of the contract assigned to the distribution rule, used for Oracle Contract Billing or Oracle Grants Management.
-
ContractName: string
Title:
Contract Name
Maximum Length:300
Name of the contract assigned to the distribution rule, used for Oracle Contract Billing or Oracle Grants Management. -
ContractNumber: string
Title:
Contract Number
Maximum Length:120
Number of the contract assigned to the distribution rule, used for Oracle Contract Billing or Oracle Grants Management. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the record was created. -
DistributionPercentage: number
Title:
Percentage
The percentage the distribution rule applies to project cost amounts and quantities. -
DistributionSetId: integer
(int64)
The unique identifier of the funding pattern distribution set.
-
DistributionSetRuleId: integer
(int64)
The date the record was last updated.
-
DistributionSetRuleNumber: integer
(int32)
The number of the funding pattern distribution set rule.
-
FundingSourceId: integer
(int64)
Identifier of the funding source for the distribution rule.
-
FundingSourceName: string
Title:
Funding Source Name
Maximum Length:360
Funding source name associated to the rule. -
FundingSourceNumber: string
Title:
Funding Source Number
Maximum Length:50
Funding source number associated to the rule. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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
- distributionSets
-
Operation: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}/child/distributionSetsParameters:
- FundingPatternId:
$request.path.FundingPatternId
The award funding patterns resource is used to view and manage the values that determine the pattern to use for a project cost based on the expenditure item date and other optional attributes. - FundingPatternId: