Jump to

• Request
• Response

Get an award funding pattern

get

/fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}

Request

Path Parameters

• FundingPatternId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : awardFundingPatterns-item-response

Type: object

Show Source

• 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 distribution sets resource is a child of the award funding patterns resource to view and manage the distribution sets that allow for one or more set of rules to apply in a precedence order.
• 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
  Title: Meaning

  Maximum Length: 80

  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

  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.

{ "type":"object", "properties":{ "LastUpdatedBy":{ "maxLength":64, "type":"string", "description":"The user who last updated the record.", "nullable":false, "readOnly":true, "x-queryable":true }, "CreationDate":{ "title":"Creation Date", "type":"string", "description":"The date the record was created.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true }, "CreatedBy":{ "title":"Created By", "maxLength":64, "type":"string", "description":"The user who created the record.", "nullable":false, "readOnly":true, "x-queryable":true }, "FundingPatternStart":{ "type":"string", "description":"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.", "format":"date", "nullable":true, "x-queryable":true }, "TaskId":{ "type":"integer", "description":"The unique identifier of the task associated to the funding pattern, if assigned at a task level.", "nullable":true, "x-hints":{ "controlType":"choice", "dependencies":[ "ProjectId", "ProjectNumber", "ProjectName" ] }, "x-queryable":true }, "ProjectName":{ "title":"Project Name", "maxLength":240, "type":"string", "description":"The project name associated to the funding pattern.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "FundingPatternEnd":{ "type":"string", "description":"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.", "format":"date", "nullable":true, "x-queryable":true }, "ProjectNumber":{ "title":"Project Number", "maxLength":25, "type":"string", "description":"The project number associated to the funding pattern.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "ProjectId":{ "maxLength":150, "type":"string", "description":"The unique identifier of the project associated to the funding pattern.", "nullable":true, "x-hints":{ "DISPLAYHINT":"Display", "PAYLOADHINT":"Show" }, "x-queryable":true }, "TaskNumber":{ "title":"Task Number", "maxLength":100, "type":"string", "description":"The task number associated to the funding pattern, if assigned at a task level.", "nullable":true, "x-hints":{ "controlType":"choice", "dependencies":[ "ProjectId", "ProjectNumber", "ProjectName" ] }, "x-queryable":true }, "distributionSets":{ "title":"Award Funding Pattern Distribution Sets", "type":"array", "description":"The distribution sets resource is a child of the award funding patterns resource to view and manage the distribution sets that allow for one or more set of rules to apply in a precedence order.", "items":{ "$ref":"#/components/schemas/awardFundingPatterns-distributionSets-item-response" } }, "FundingPatternName":{ "maxLength":200, "type":"string", "description":"The name of the funding pattern.", "nullable":true, "x-queryable":true }, "FundingPatternStatusCode":{ "maxLength":30, "type":"string", "description":"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.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "FundingPatternStatus":{ "title":"Meaning", "maxLength":80, "type":"string", "description":"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.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "TaskName":{ "title":"Task Name", "maxLength":255, "type":"string", "description":"The task name associated to the funding pattern, if assigned at a task level.", "nullable":true, "x-hints":{ "controlType":"choice", "dependencies":[ "ProjectId", "ProjectNumber", "ProjectName" ] }, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "FundingPatternDescription":{ "maxLength":2000, "type":"string", "description":"The description of the funding pattern.", "nullable":true, "x-queryable":true }, "LastUpdateDate":{ "type":"string", "description":"The date the record was last updated.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true }, "FundingPatternId":{ "type":"integer", "description":"The unique identifier of the funding pattern.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true } } }

Nested Schema : Award Funding Pattern Distribution Sets

Type: array

Title: Award Funding Pattern Distribution Sets

The distribution sets resource is a child of the award funding patterns resource to view and manage the distribution sets that allow for one or more set of rules to apply in a precedence order.

Show Source

• Array of: object awardFundingPatterns-distributionSets-item-response

{ "title":"Award Funding Pattern Distribution Sets", "type":"array", "description":"The distribution sets resource is a child of the award funding patterns resource to view and manage the distribution sets that allow for one or more set of rules to apply in a precedence order.", "items":{ "$ref":"#/components/schemas/awardFundingPatterns-distributionSets-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 : awardFundingPatterns-distributionSets-item-response

Type: object

Show Source

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

{ "type":"object", "properties":{ "LastUpdatedBy":{ "maxLength":64, "type":"string", "description":"The user who last updated the record.", "nullable":false, "readOnly":true, "x-queryable":true }, "CreationDate":{ "type":"string", "description":"The date the record was created.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true }, "SetDescription":{ "maxLength":2000, "type":"string", "description":"The description of the funding pattern distribution set.", "nullable":true, "x-queryable":true }, "CreatedBy":{ "maxLength":64, "type":"string", "description":"The user who created the record.", "nullable":false, "readOnly":true, "x-queryable":true }, "DistributionSetId":{ "type":"integer", "description":"The unique identifier of the funding pattern distribution set.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "SetName":{ "maxLength":200, "type":"string", "description":"The name of the funding pattern distribution set.", "nullable":false, "x-queryable":true }, "Precedence":{ "type":"integer", "description":"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.", "format":"int32", "nullable":false, "x-hints":{ "precision":9 }, "x-queryable":true }, "LastUpdateDate":{ "type":"string", "description":"The date the record was last updated.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true }, "FundingPatternId":{ "type":"integer", "description":"The unique identifier of the funding pattern.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "distributionSetRules":{ "title":"Award Funding Pattern Distribution Set Rules", "type":"array", "description":"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.", "items":{ "$ref":"#/components/schemas/awardFundingPatterns-distributionSets-distributionSetRules-item-response" } } } }

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

• Array of: object awardFundingPatterns-distributionSets-distributionSetRules-item-response

{ "title":"Award Funding Pattern Distribution Set Rules", "type":"array", "description":"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.", "items":{ "$ref":"#/components/schemas/awardFundingPatterns-distributionSets-distributionSetRules-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 : awardFundingPatterns-distributionSets-distributionSetRules-item-response

Type: object

Show Source

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

{ "type":"object", "properties":{ "LastUpdatedBy":{ "title":"Last Updated By", "maxLength":64, "type":"string", "description":"The user who last updated the record.", "nullable":false, "readOnly":true, "x-queryable":true }, "CreationDate":{ "title":"Creation Date", "type":"string", "description":"The date the record was created.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true }, "ContractNumber":{ "title":"Contract Number", "maxLength":120, "type":"string", "description":"Number of the contract assigned to the distribution rule, used for Oracle Contract Billing or Oracle Grants Management.", "nullable":false, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "CreatedBy":{ "title":"Created By", "maxLength":64, "type":"string", "description":"The user who created the record.", "nullable":false, "readOnly":true, "x-queryable":true }, "DistributionSetId":{ "type":"integer", "description":"The unique identifier of the funding pattern distribution set.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "DistributionSetRuleNumber":{ "type":"integer", "description":"The number of the funding pattern distribution set rule.", "format":"int32", "nullable":false, "x-hints":{ "precision":9 }, "x-queryable":true }, "ContractId":{ "type":"integer", "description":"Identifier of the contract assigned to the distribution rule, used for Oracle Contract Billing or Oracle Grants Management.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "DistributionSetRuleId":{ "type":"integer", "description":"The date the record was last updated.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true }, "DistributionPercentage":{ "title":"Percentage", "type":"number", "description":"The percentage the distribution rule applies to project cost amounts and quantities.", "nullable":false, "x-hints":{ "precision":5, "scale":2 }, "x-queryable":true }, "FundingSourceName":{ "title":"Funding Source Name", "maxLength":360, "type":"string", "description":"Funding source name associated to the rule.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "ContractName":{ "title":"Contract Name", "maxLength":300, "type":"string", "description":"Name of the contract assigned to the distribution rule, used for Oracle Contract Billing or Oracle Grants Management.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "FundingSourceId":{ "type":"integer", "description":"Identifier of the funding source for the distribution rule.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "FundingSourceNumber":{ "title":"Funding Source Number", "maxLength":50, "type":"string", "description":"Funding source number associated to the rule.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "LastUpdateDate":{ "title":"Last Updated Date", "type":"string", "description":"The date the record 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

distributionSets

Operation: /fscmRestApi/resources/11.13.18.05/awardFundingPatterns/{FundingPatternId}/child/distributionSets

Parameters:

• FundingPatternId: $request.path.FundingPatternId

The distribution sets resource is a child of the award funding patterns resource to view and manage the distribution sets that allow for one or more set of rules to apply in a precedence order.

Back to Top