Get an award distribution
get
/fscmRestApi/resources/11.13.18.05/projectAwardDistributions/{AwardDistributionId}
Request
Path Parameters
-
AwardDistributionId(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:
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.
There's no request body for this operation.
Back to TopResponse
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 : projectAwardDistributions-item-response
Type:
Show Source
object
-
AwardDistributionBatchId: integer
(int64)
Batch identifier assigned to the set of transactions provided in the input payload.
-
AwardDistributionId: integer
(int64)
Read Only:
true
Unique identifier of the transactions in the batch. -
AwardDistributionStatus: string
Maximum Length:
30
Award distribution status indicator for the transaction. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DenomCurrencyCode: string
Maximum Length:
15
The transaction currency code. -
DistributePatternId: integer
(int64)
Unique identifier of the funding pattern that was used to distribute the transaction.
-
DistributePatternSetId: integer
(int64)
Unique identifier of the funding pattern distribution set that was used to distribute the transaction.
-
FundingPatternEnd: string
(date)
Read Only:
true
The end date of the funding pattern that, with the start date, defines the expenditure item date range applicable to the pattern. -
FundingPatternName: string
Read Only:
true
Maximum Length:200
The user-defined name of the funding pattern. -
FundingPatternStart: string
(date)
Read Only:
true
The start date of the funding pattern that, with the end date, defines the expenditure item date range applicable to the pattern. -
FundingPatternStatus: string
Title:
Meaning
Read Only:true
Maximum Length:80
The status of the funding pattern at the time this distribution was created. -
FundingPatternTaskName: string
Title:
Task Name
Read Only:true
Maximum Length:255
The name of the project task defined as a determinant on the funding pattern. -
FundingPatternTaskNumber: string
Title:
Task Number
Read Only:true
Maximum Length:100
The number of the project task defined as a determinant on 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 that last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectAwardDistributionErrors: array
Project Award Distribution Errors
Title:
Project Award Distribution Errors
This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process. -
ProjectAwardDistributionLines: array
Project Award Cost Distribution Records
Title:
Project Award Cost Distribution Records
This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process. -
ProjectAwardDistributionSuccessLines: array
Project Award Cost Distribution Records
Title:
Project Award Cost Distribution Records
This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process. -
ProjectName: string
Title:
Project Name
Read Only:true
Maximum Length:240
The name of the project associated with the cost to be distributed. -
ProjectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
The number of the project on the cost to be distributed. -
ProviderLedgerCurrencyCode: string
Maximum Length:
15
The provider ledger currency code. -
SourceLineIdFive: string
Maximum Length:
30
Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process. -
SourceLineIdFour: string
Maximum Length:
30
Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process. -
SourceLineIdOne: string
Maximum Length:
30
Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process. -
SourceLineIdSix: string
Maximum Length:
30
Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process. -
SourceLineIdThree: string
Maximum Length:
30
Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process. -
SourceLineIdTwo: string
Maximum Length:
30
Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process. -
TransactionNumber: string
Maximum Length:
240
The transaction number that uniquely identifies the source transaction within the application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Project Award Distribution Errors
Type:
array
Title:
Project Award Distribution Errors
This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process.
Show Source
Nested Schema : Project Award Cost Distribution Records
Type:
array
Title:
Project Award Cost Distribution Records
This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process.
Show Source
Nested Schema : Project Award Cost Distribution Records
Type:
array
Title:
Project Award Cost Distribution Records
This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process.
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.
Nested Schema : projectAwardDistributions-ProjectAwardDistributionErrors-item-response
Type:
Show Source
object
-
ApplicationCode: string
Read Only:
true
Maximum Length:10
The application code associated with the message. -
ErrorAction: string
Read Only:
true
Maximum Length:255
The description of the action that users should take to resolve the error. -
ErrorGroup: string
Read Only:
true
Maximum Length:30
Name of the award distribution processing stage that generated the error. -
InterfaceId: integer
(int64)
Read Only:
true
Identifier of the request that initiated the process. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageName: string
Read Only:
true
Maximum Length:30
The name of the error message associated with the transaction. -
MessageText: string
Read Only:
true
Maximum Length:255
Award distribution error message text. -
MessageTypeCode: string
Read Only:
true
Maximum Length:20
The type of error message associated with the transaction. -
SourceTransactionId: integer
(int64)
Read Only:
true
The identifier of the source of the transaction. -
TransactionErrorId: integer
(int64)
Read Only:
true
Unique identifier of the distribution error record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectAwardDistributions-ProjectAwardDistributionLines-item-response
Type:
Show Source
object
-
AwardDistributionId: integer
(int64)
Unique identifier of the award distribution associated with the distribution line.
-
AwardDistributionLineId: integer
(int64)
Read Only:
true
Unique identifier of the distribution line. -
AwardDistributionStatus: string
Maximum Length:
30
Award distribution status indicator associated with the distribution line. -
AwardName: string
Title:
Name
Read Only:true
Maximum Length:300
The name of the award on the funding pattern distribution set rule. -
AwardNumber: string
Title:
Number
Read Only:true
Maximum Length:120
The number of the award on the funding pattern distribution set rule. -
BudgetaryControlValueStatus: string
Maximum Length:
120
Budgetary control status of the distribution line, indicating whether it passed the check funds process. -
BurdenedCostInProviderLedgerCurrency: number
Distributed burdened cost in provider ledger currency.
-
ContractId: integer
(int64)
Identifier of the contract from the distribution rule that created the distribution line.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DenomBurdenedCost: number
Distributed burdened cost in transaction currency.
-
DenomRawCost: number
Distributed raw cost upon applying the distribution percentage, in transaction currency.
-
DistBaseAmount: number
Raw cost from the original transaction, in transaction currency.
-
DistBaseQuantity: number
Quantity from the original transaction.
-
DistBurdenedCostInProviderLedgerCurrency: number
Burdened cost from the original transaction, in provider ledger currency.
-
DistDenomBurdenedCost: number
Burdened cost from original transaction, in transaction currency.
-
DistRawCostInProviderLedgerCurrency: number
Raw cost from original transaction, in provider ledger currency.
-
DistributePatternRuleId: integer
(int64)
Identifier of the funding pattern distribution set rule.
-
DistributePatternSetId: integer
(int64)
Identifier of the distribution set that's the parent to the rule used to generate this line.
-
DistributeRuleSetNumber: integer
(int32)
Number of the funding pattern distribution set.
-
DistributionPercentage: number
Percentage of the funding pattern distribution set rule.
-
DistributionSetName: string
Read Only:
true
Maximum Length:200
The user-defined name of the distribution set. -
DistributionSetPrecedence: integer
(int32)
Order in which the distribution rules in the funding pattern distribution set must be applied.
-
FundingSourceId: integer
(int64)
Identifier of the contract funding source in the distribution rule that created the distribution line.
-
FundingSourceName: string
Read Only:
true
Maximum Length:360
The name of the funding source on the funding pattern distribution set rule. -
FundingSourceNumber: string
Read Only:
true
Maximum Length:50
The number of the funding source on the funding pattern distribution set rule. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectAwardDistributionErrors: array
Project Award Distribution Errors
Title:
Project Award Distribution Errors
This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process. -
Quantity: number
Quantity distributed upon applying the distribution percentage.
-
RawCostInProviderLedgerCurrency: number
Distributed raw cost in provider ledger currency.
-
ValidationStatusCode: string
Maximum Length:
30
The distribution line validation code, indicating whether it passed project cost validation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Project Award Distribution Errors
Type:
array
Title:
Project Award Distribution Errors
This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process.
Show Source
Nested Schema : projectAwardDistributions-ProjectAwardDistributionLines-ProjectAwardDistributionErrors-item-response
Type:
Show Source
object
-
ApplicationCode: string
Read Only:
true
Maximum Length:10
The application code associated with the message. -
ErrorAction: string
Read Only:
true
Maximum Length:255
The description of the action that users should take to resolve the error. -
ErrorGroup: string
Read Only:
true
Maximum Length:30
Name of the award distribution processing stage that generated the error. -
InterfaceId: integer
(int64)
Read Only:
true
Identifier of the request that initiated the process. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageName: string
Read Only:
true
Maximum Length:30
The name of the error message associated with the transaction. -
MessageText: string
Read Only:
true
Maximum Length:255
Award distribution error message text. -
MessageTypeCode: string
Read Only:
true
Maximum Length:20
The type of error message associated with the transaction. -
SourceTransactionId: integer
(int64)
Read Only:
true
The identifier of the source of the transaction. -
TransactionErrorId: integer
(int64)
Read Only:
true
Unique identifier of the distribution error record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectAwardDistributions-ProjectAwardDistributionSuccessLines-item-response
Type:
Show Source
object
-
AwardDistributionId: integer
(int64)
Unique identifier of the award distribution associated with the distribution line.
-
AwardDistributionLineId: integer
(int64)
Read Only:
true
Unique identifier of the distribution line. -
AwardDistributionStatus: string
Maximum Length:
30
Award distribution status indicator associated with the distribution line. -
AwardName: string
Title:
Name
Read Only:true
Maximum Length:300
The name of the award on the funding pattern distribution set rule. -
AwardNumber: string
Title:
Number
Read Only:true
Maximum Length:120
The number of the award on the funding pattern distribution set rule. -
BudgetaryControlValueStatus: string
Maximum Length:
120
Budgetary control status of the distribution line, indicating whether it passed the check funds process. -
BurdenedCostInProviderLedgerCurrency: number
Distributed burdened cost in provider ledger currency.
-
ContractId: integer
(int64)
Identifier of the contract from the distribution rule that created the distribution line.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DenomBurdenedCost: number
Distributed burdened cost in transaction currency.
-
DenomRawCost: number
Distributed raw cost upon applying the distribution percentage, in transaction currency.
-
DistBaseAmount: number
Raw cost from the original transaction, in transaction currency.
-
DistBaseQuantity: number
Quantity from the original transaction.
-
DistBurdenedCostInProviderLedgerCurrency: number
Burdened cost from the original transaction, in provider ledger currency.
-
DistDenomBurdenedCost: number
Burdened cost from original transaction, in transaction currency.
-
DistRawCostInProviderLedgerCurrency: number
Raw cost from original transaction, in provider ledger currency.
-
DistributePatternRuleId: integer
(int64)
Identifier of the funding pattern distribution set rule.
-
DistributePatternSetId: integer
(int64)
Identifier of the distribution set that's the parent to the rule used to generate this line.
-
DistributeRuleSetNumber: integer
(int32)
Number of the funding pattern distribution set.
-
DistributionPercentage: number
Percentage of the funding pattern distribution set rule.
-
DistributionSetName: string
Read Only:
true
Maximum Length:200
The user-defined name of the distribution set. -
DistributionSetPrecedence: integer
(int32)
Order in which the distribution rules in the funding pattern distribution set must be applied.
-
FundingSourceId: integer
(int64)
Identifier of the contract funding source in the distribution rule that created the distribution line.
-
FundingSourceName: string
Read Only:
true
Maximum Length:360
The name of the funding source on the funding pattern distribution set rule. -
FundingSourceNumber: string
Read Only:
true
Maximum Length:50
The number of the funding source on the funding pattern distribution set rule. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Quantity: number
Quantity distributed upon applying the distribution percentage.
-
RawCostInProviderLedgerCurrency: number
Distributed raw cost in provider ledger currency.
-
ValidationStatusCode: string
Maximum Length:
30
The distribution line validation code, indicating whether it passed project cost validation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ProjectAwardDistributionErrors
-
Parameters:
- AwardDistributionId:
$request.path.AwardDistributionId
This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process. - AwardDistributionId:
- ProjectAwardDistributionLines
-
Parameters:
- AwardDistributionId:
$request.path.AwardDistributionId
This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process. - AwardDistributionId:
- ProjectAwardDistributionSuccessLines
-
Parameters:
- AwardDistributionId:
$request.path.AwardDistributionId
This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process. - AwardDistributionId: