Get an award project
get
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}
Request
Path Parameters
-
AwardId(required): integer(int64)
Unique identifier of the award.
-
AwardProjectId(required): integer(int64)
Unique identifier of the award project.
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:
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.
Root Schema : awards-AwardProject-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
Unique identifier of the award. -
AwardName: string
Title:
Award Name
Read Only:true
Maximum Length:300
Name of the award. Mandatory for POST operation. -
AwardNumber: string
Title:
Award Number
Read Only:true
Maximum Length:120
Number of the award. -
AwardProjectAttachment: array
Award Project Attachments
Title:
Award Project Attachments
The Award Project Attachments resource is used to view attachments associated with the award project. -
AwardProjectCertification: array
Award Project Certifications
Title:
Award Project Certifications
The Award Project Certifications resource is used to view certification attributes of the award project. -
AwardProjectDepartmentCredit: array
Award Project Organization Credits
Title:
Award Project Organization Credits
The Award Project Organization Credits resource is used to view organization credit attributes for the award project. -
AwardProjectDFF: array
Award Project Descriptive Flexfields
Title:
Award Project Descriptive Flexfields
A list of all the descriptive flexfields available for award projects. -
AwardProjectFundingSource: array
Award Project Funding Sources
Title:
Award Project Funding Sources
The Award Project Funding Sources resource is used to assign funding sources to the award project. -
AwardProjectId: integer
(int64)
Title:
Award Project ID
Unique identifier of the award project. -
AwardProjectKeyword: array
Award Project Keywords
Title:
Award Project Keywords
The Award Project Keywords resource is used to view keyword attributes for the award project. -
AwardProjectOverrideBurdenSchedules: array
Award Project Override Burden Schedules
Title:
Award Project Override Burden Schedules
The Award Project Override Burden Schedules resource is used to create and view the override burden schedule assigned to the award project. -
AwardProjectPersonnel: array
Award Project Personnel
Title:
Award Project Personnel
The Award Project Personnel resource is used to view personnel references associated with the award project -
AwardProjectReference: array
Award Project Reference Types
Title:
Award Project Reference Types
The Award Project Reference Types resource is used to view attributes associated with the award project reference type. -
AwardProjectTaskBurdenSchedule: array
Award Project Task Burden Schedules
Title:
Award Project Task Burden Schedules
The Award Project Task Burden Schedules resource is used to view the task burden schedule of the award project. -
BurdenScheduleFixedDate: string
(date)
Title:
Fixed Date
Specific date used to determine the right set of burden multipliers for the award project. -
BurdenScheduleId: integer
(int64)
Title:
Burden Schedule ID
The unique identifier of the burden schedule. -
BurdenScheduleName: string
Title:
Burden Schedule
Maximum Length:30
Name of the burden schedule assigned at the award project level. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award project -
CreationDate: string
(date-time)
Read Only:
true
The date when the award project was created. -
CurrencyCode: string
Title:
Currency
Currency code representing the award project currency. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award project was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award project. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectId: integer
(int64)
Title:
Project ID
Unique identifier of the award project. -
ProjectName: string
Title:
Project Name
Maximum Length:240
Name of the project associated to the award. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Number of the project associated to the award.
Nested Schema : Award Project Attachments
Type:
array
Title:
Award Project Attachments
The Award Project Attachments resource is used to view attachments associated with the award project.
Show Source
Nested Schema : Award Project Certifications
Type:
array
Title:
Award Project Certifications
The Award Project Certifications resource is used to view certification attributes of the award project.
Show Source
Nested Schema : Award Project Organization Credits
Type:
array
Title:
Award Project Organization Credits
The Award Project Organization Credits resource is used to view organization credit attributes for the award project.
Show Source
Nested Schema : Award Project Descriptive Flexfields
Type:
array
Title:
Award Project Descriptive Flexfields
A list of all the descriptive flexfields available for award projects.
Show Source
Nested Schema : Award Project Funding Sources
Type:
array
Title:
Award Project Funding Sources
The Award Project Funding Sources resource is used to assign funding sources to the award project.
Show Source
Nested Schema : Award Project Keywords
Type:
array
Title:
Award Project Keywords
The Award Project Keywords resource is used to view keyword attributes for the award project.
Show Source
Nested Schema : Award Project Override Burden Schedules
Type:
array
Title:
Award Project Override Burden Schedules
The Award Project Override Burden Schedules resource is used to create and view the override burden schedule assigned to the award project.
Show Source
Nested Schema : Award Project Personnel
Type:
array
Title:
Award Project Personnel
The Award Project Personnel resource is used to view personnel references associated with the award project
Show Source
Nested Schema : Award Project Reference Types
Type:
array
Title:
Award Project Reference Types
The Award Project Reference Types resource is used to view attributes associated with the award project reference type.
Show Source
Nested Schema : Award Project Task Burden Schedules
Type:
array
Title:
Award Project Task Burden Schedules
The Award Project Task Burden Schedules resource is used to view the task burden schedule of 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-AwardProject-AwardProjectAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user that created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user that created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The creation date of the attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment assigned to the award. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The direct folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the attachment. -
FileContents: string
(byte)
Title:
File Contents
The type of attachment files such as.pdf,.xls, when the attachment type is File. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment when the attachment type is URL. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the document was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User that last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user that last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Name of the attachment assigned to the award. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The type of the attachment such as URL, file or text provided at the award or award project level. -
UploadedFileLength: integer
Title:
File Size
The name of the file uploaded. -
UploadedFileName: string
Title:
Uploaded File Name
The size of the attachment. -
UploadedText: string
Title:
Uploaded Text
The uploaded text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment when the attachment type is URI. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment when the attachment type is URL. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The user name of the owner of the attachment.
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.
Nested Schema : awards-AwardProject-AwardProjectCertification-item-response
Type:
Show Source
object
-
ApprovalDate: string
(date)
Title:
Approval Date
Date when the award project certification was approved. -
AssuranceNumber: string
Title:
Assurance Number
Maximum Length:20
Assurance of compliance number. Indicates that the organization complies with the regulations for the protection of animal or human research subjects. -
AwardId: integer
(int64)
Title:
Award ID
Unique identifier of the award. -
AwardProjectCertificationId: integer
(int64)
Title:
Award Project Certification ID
Unique identifier of the certification assigned to the award or award project. -
AwdProjectLnkId: integer
(int64)
Title:
Award Project Link ID
Unique identifier of the award project. -
CertificationDate: string
(date)
Title:
Certification Date
Date when the certification for the award project was performed. -
CertificationId: integer
(int64)
Title:
Certification ID
Unique identifier of the certification. -
CertificationName: string
Title:
Certification Name
Maximum Length:80
Name of the award project certification. -
CertificationStatus: string
Title:
Status
Maximum Length:10
Status of the award project certification. -
CertifiedBy: integer
(int64)
Title:
Certified By
Unique identifier of the person certifying the award project certification. -
CertifiedByPersonName: string
Title:
Certified By
Maximum Length:240
Person certifying the award project certification. -
Comments: string
Title:
Comments
Maximum Length:4000
Comments for the award project certification. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award project certification. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award project certification was created. -
ExemptionNumber: string
Title:
Exemption Number
Maximum Length:20
Number that determines whether the research involves no more than minimal risk and meets criteria specified by federal regulations, and is therefore exempt from protocol approvals. -
ExpeditedReviewFlag: boolean
Title:
Expedited Review
Maximum Length:1
Indicates whether the award project certification requires an expedited review. -
ExpirationDate: string
(date)
Title:
Expiration Date
Date when the award project certification expires. -
FullReviewFlag: boolean
Title:
Full Review
Maximum Length:1
Indicates if the award project certification requires a full review. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award project certification was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award project certification. -
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 : awards-AwardProject-AwardProjectDepartmentCredit-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
Unique identifier of the award. -
AwardOrganizationCreditId: integer
(int64)
Title:
Award Organization ID
Unique identifier of the organization credit assigned to the award or award project. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award project organization credit. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award project organization credit was created. -
CreditPercentage: number
Title:
Percentage
Percentage of credit that the organization receives. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award project organization credit was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award project organization credit. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Title:
Organization ID
The unique identifier of the organization. -
OrganizationName: string
Title:
Organization
Maximum Length:240
Name of the organization that receives credit.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardProject-AwardProjectDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Structure definition of the Award Descriptive Flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Id: integer
(int64)
System-generated primary key column.
-
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 : awards-AwardProject-AwardProjectFundingSource-item-response
Type:
Show Source
object
-
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. -
AwardProjectFundingSourceId: integer
(int64)
Unique identifier of the funding source assignment to the award project.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award project funding source. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award project funding source was created. -
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. -
FundingSourceType: string
Title:
Funding Source Type
Read Only:true
Maximum Length:80
Type of the funding source. -
InternalFundingSourceBurdeningFlag: boolean
Maximum Length:
1
Enable or disable Burdening for the Internal Funding Source. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award project funding source was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award project funding source. -
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 : awards-AwardProject-AwardProjectKeyword-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Unique identifier of the award.
-
AwardProjectKeywordId: integer
(int64)
Title:
Award Project Keyword ID
Unique identifier of the keyword assigned to the award or award project. -
AwardProjectLinkId: integer
(int64)
Unique identifier of the award project.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award project keyword. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award project keyword was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the keyword associated with the award project. -
KeywordId: integer
(int64)
Title:
Keyword ID
Unique identifier of the keyword. -
KeywordName: string
Title:
Name
Maximum Length:80
Name of the keyword used to describe and track the subject of the award or award project. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award project keyword was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award project keyword. -
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 : awards-AwardProject-AwardProjectOverrideBurdenSchedules-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
Identifier of the award. -
AwardProjectId: integer
(int64)
Title:
Award Project ID
Identifier of the award project. -
BurdenScheduleDescription: string
Title:
Description
Maximum Length:250
The description of a burden schedule which is set of burden multipliers that is maintained for use across projects. -
BurdenScheduleId: integer
(int64)
Title:
Burden Schedule ID
Read Only:true
Identifier of the burden schedule. -
BurdenScheduleName: string
Title:
Burden Schedule
Maximum Length:30
The name of a burden schedule which is set of burden multipliers that is maintained for use across projects. -
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 when the record was created. -
DefaultBurdenStructureName: string
Title:
Default Burden Structure
Maximum Length:30
The name of a burden structure which is assigned as the default burden structure on a burden schedule. A burden structure determines how cost bases are grouped and what types of burden costs are applied to the cost bases. -
DefaultOrganizationHierarchyCode: string
Title:
Default Organization Hierarchy Code
Maximum Length:30
The internal code of the structure that determines the relationships between organizations. -
DefaultOrganizationHierarchyName: string
Title:
Default Organization Hierarchy
Maximum Length:80
A structure that determines the relationships between organizations like which organizations are subordinate to other organizations. This hierarchy is the default hierarchy for burden schedule versions. -
HierarchyStartOrganizationId: integer
(int64)
Title:
Hierarchy Start Organization ID
The identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule. -
HierarchyStartOrganizationName: string
Title:
Hierarchy Start Organization
Maximum Length:240
The top-level organization of the organization hierarchy that is assigned to the burden schedule. -
HierarchyVersionId: string
Title:
Hierarchy Version ID
Maximum Length:32
The identifier of the version of the organization hierarchy that is assigned to the burden schedule. -
HierarchyVersionName: string
Title:
Hierarchy Version
Maximum Length:80
The version of the organization hierarchy that is assigned to the burden schedule. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the record was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationClassificationCode: string
Title:
Organization Classification Code
The internal code for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
OrganizationClassificationName: string
Title:
Organization Classification
The name for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
Versions: array
Versions
Title:
Versions
The Versions resource is used to view and create versions for the override burden schedule assigned to the award project.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Versions
Type:
array
Title:
Versions
The Versions resource is used to view and create versions for the override burden schedule assigned to the award project.
Show Source
Nested Schema : awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-item-response
Type:
Show Source
object
-
BuildStatus: string
Title:
Build Status
Read Only:true
Maximum Length:80
The current state of a burden schedule version in relation to build processing. The status can be New, Active, or Active with Unbuilt Changes. -
BurdenScheduleId: integer
(int64)
Title:
Burden Schedule ID
Identifier of the burden schedule. -
BurdenStructureName: string
Title:
Burden Structure
Maximum Length:30
The name of a burden structure which is assigned to a burden schedule version. A burden structure determines how cost bases are grouped and what types of burden costs are applied to the cost bases. -
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 when the record was created. -
HierarchyStartOrganizationId: integer
(int64)
Title:
Hierarchy Start Organization ID
The identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyStartOrganizationName: string
Title:
Hierarchy Start Organization
Maximum Length:240
The top-level organization of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyVersionId: string
Title:
Hierarchy Version ID
Maximum Length:32
The identifier of the version of the organization hierarchy that is assigned to the burden schedule version. -
HierarchyVersionName: string
Title:
Hierarchy Version
Maximum Length:80
The version of the organization hierarchy that is assigned to the burden schedule version. -
HoldVersionFromBuildFlag: boolean
Title:
Hold Version from Build
Maximum Length:1
Indicates that the build rate schedule process will skip the schedule version even if it has been built. -
LastActiveBuildDate: string
(date)
Title:
Last Active Build Date
Read Only:true
The date on which a burden schedule version most recently underwent successful build processing. Because the processing was successful, the multipliers on the version are available for use. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the record was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Multipliers: array
Multipliers
Title:
Multipliers
The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project. -
OrganizationClassificationCode: string
Title:
Organization Classification Code
The internal code for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
OrganizationClassificationName: string
Title:
Organization Classification
The name for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
OrganizationHierarchyCode: string
Title:
Organization Hierarchy Code
Maximum Length:30
The internal code of the structure that determines the relationships between organizations. -
OrganizationHierarchyName: string
Title:
Organization Hierarchy
Maximum Length:80
A structure that determines the relationships between organizations like which organizations are subordinate to other organizations. -
VersionEndDate: string
(date)
Title:
To Date
The date after which a burden schedule version is no longer active. -
VersionId: integer
(int64)
Title:
Version ID
Read Only:true
The identifier of the version of a set of burden multipliers. -
VersionName: string
Title:
Version
Maximum Length:30
A version of a burden schedule is a set of burden multipliers. One burden schedule can have many versions. -
VersionStartDate: string
(date)
Title:
From Date
The date from which a burden schedule version is active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Multipliers
Type:
array
Title:
Multipliers
The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project.
Show Source
Nested Schema : awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-Multipliers-item-response
Type:
Show Source
object
-
BurdenCostCode: string
Title:
Burden Cost Code
Maximum Length:30
The name of a burden cost code for which you are defining multipliers on a burden schedule version. A burden cost code is a classification of overhead costs and it represents the type of burden cost you want to apply to raw cost. -
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 when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the record was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MultiplierId: integer
(int64)
Title:
Multiplier ID
Read Only:true
Identifier of the burden multiplier. -
MultiplierNumber: number
Title:
Multiplier
A numeric multiplier associated with an organization and burden cost code combinations for burden schedule versions. The costing process applies this multiplier to raw cost to calculate burden cost amounts. -
OrganizationClassificationCode: string
Title:
Organization Classification Code
The internal code for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
OrganizationClassificationName: string
Title:
Organization Classification
The name for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks. -
OrganizationId: integer
(int64)
Title:
Organization ID
Identifier of the organization to which a burden multiplier is assigned for a particular burden cost code. -
OrganizationName: string
Title:
Organization
Maximum Length:240
The organization to which a burden multiplier is assigned for a particular burden cost code. -
VersionId: integer
(int64)
Title:
Version ID
The identifier of the version of a set of burden multipliers.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardProject-AwardProjectPersonnel-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
Unique identifier of the award. -
AwardProjectPersonnelDFF: array
Award Project Personnel Descriptive Flexfields
Title:
Award Project Personnel Descriptive Flexfields
A list of all the descriptive flexfields available for award project personnel. -
AwardProjectPersonnelId: integer
(int64)
Title:
Award Project Personnel ID
Unique identifier of the project personnel. -
AwdProjectLnkId: 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 personnel. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award project personnel was created. -
CreditPercentage: number
Title:
Credit Percentage
Percentage of credit that the person assigned to the award project receives. -
EmailAddress: string
Title:
Email
E-mail of the person selected from Human Resources to administer and manage awards. -
EndDate: string
(date)
Title:
End Date
End date for the person assigned to the award project. -
InternalFlag: boolean
Title:
Internal
Maximum Length:1
Default Value:true
Indicates whether the person is internal, for example, an employee; or external, for example, customer contact. -
JobTitle: string
Title:
Primary Job
Primary job profile of the person selected from Human Resources to administer and manage awards. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award project personnel was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award project personnel. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Title:
Primary Organization
Primary organization of the person selected from Human Resources to administer and manage awards. -
PartyId: integer
(int64)
Title:
Personnel ID
The unique identifier of the party in Oracle Fusion Trading Community Architecture. -
PersonId: integer
(int64)
Title:
Personnel ID
The unique identifier of the person in human resources. -
PersonName: string
Title:
Person Name
Name of the person assigned to the award project. -
PersonNumber: string
Title:
Person Number
Number of the person selected from Human Resources to administer and manage awards. -
PhoneNumber: string
Title:
Phone
Phone number of the person selected from Human Resources to administer and manage awards. -
RoleId: integer
(int64)
Title:
Role ID
Unique identifier of the role for the internal person assigned to the award project. -
RoleName: string
Title:
Role
Maximum Length:240
Role for the internal person assigned to the award project. -
StartDate: string
(date)
Title:
Start Date
Start date for the person assigned to the award project.
Nested Schema : Award Project Personnel Descriptive Flexfields
Type:
array
Title:
Award Project Personnel Descriptive Flexfields
A list of all the descriptive flexfields available for award project personnel.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardProject-AwardProjectPersonnel-AwardProjectPersonnelDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Structure definition of the Award Personnel Descriptive Flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Id: integer
(int64)
System-generated primary key column.
-
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 : awards-AwardProject-AwardProjectReference-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
Unique identifier of the award. -
AwardProjectReferenceId: integer
(int64)
Title:
Award Project Reference ID
Unique identifier of the reference type assigned to the award. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award project reference. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award project reference was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the reference type assigned to an award project. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award project reference was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award project reference. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReferenceComment: string
Title:
Comments
Maximum Length:4000
Comments for the reference type or value assigned to the award. -
ReferenceId: integer
(int64)
Title:
Reference ID
Unique identifier of the reference type. -
ReferenceTypeName: string
Title:
Reference Type Name
Maximum Length:80
Name of the reference type assigned to an award project for identification purposes. For example, Proposal Number. -
ReferenceValue: string
Title:
Value
Maximum Length:300
Value of the reference type, for example, the related proposal number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardProject-AwardProjectTaskBurdenSchedule-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
Unique identifier of the award. -
AwardProjectScheduleId: integer
(int64)
Title:
Award Project Schedule ID
Unique identifier of the project schedule -
BurdenScheduleFixedDate: string
(date)
Title:
Fixed Date
Fixed date of the burden schedule -
BurdenScheduleId: integer
(int64)
Title:
Burden Schedule ID
The unique identifier of the burden schedule specified at the project or project task of an award. -
BurdenScheduleName: string
Title:
Burden Schedule
Maximum Length:30
Name of the burden schedule -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award project burden schedule -
CreationDate: string
(date-time)
Read Only:
true
The date when the award project burden schedule was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award project burden schedule was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award project burden schedule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectId: integer
(int64)
Title:
Project ID
Unique identifier of the project. -
TaskId: integer
(int64)
Title:
Task ID
Unique identifier of the task. -
TaskName: string
Title:
Task Name
Maximum Length:255
Name of the task to which the funding is allocated. -
TaskNumber: string
Title:
Task Number
Maximum Length:100
Number of the task to which the funding is allocated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AwardProjectAttachment
-
Parameters:
- AwardId:
$request.path.AwardId
- AwardProjectId:
$request.path.AwardProjectId
The Award Project Attachments resource is used to view attachments associated with the award project. - AwardId:
- AwardProjectCertification
-
Parameters:
- AwardId:
$request.path.AwardId
- AwardProjectId:
$request.path.AwardProjectId
The Award Project Certifications resource is used to view certification attributes of the award project. - AwardId:
- AwardProjectDFF
-
Parameters:
- AwardId:
$request.path.AwardId
- AwardProjectId:
$request.path.AwardProjectId
A list of all the descriptive flexfields available for award projects. - AwardId:
- AwardProjectDepartmentCredit
-
Parameters:
- AwardId:
$request.path.AwardId
- AwardProjectId:
$request.path.AwardProjectId
The Award Project Organization Credits resource is used to view organization credit attributes for the award project. - AwardId:
- AwardProjectFundingSource
-
Parameters:
- AwardId:
$request.path.AwardId
- AwardProjectId:
$request.path.AwardProjectId
The Award Project Funding Sources resource is used to assign funding sources to the award project. - AwardId:
- AwardProjectKeyword
-
Parameters:
- AwardId:
$request.path.AwardId
- AwardProjectId:
$request.path.AwardProjectId
The Award Project Keywords resource is used to view keyword attributes for the award project. - AwardId:
- AwardProjectOverrideBurdenSchedules
-
Parameters:
- AwardId:
$request.path.AwardId
- AwardProjectId:
$request.path.AwardProjectId
The Award Project Override Burden Schedules resource is used to create and view the override burden schedule assigned to the award project. - AwardId:
- AwardProjectPersonnel
-
Parameters:
- AwardId:
$request.path.AwardId
- AwardProjectId:
$request.path.AwardProjectId
The Award Project Personnel resource is used to view personnel references associated with the award project - AwardId:
- AwardProjectReference
-
Parameters:
- AwardId:
$request.path.AwardId
- AwardProjectId:
$request.path.AwardProjectId
The Award Project Reference Types resource is used to view attributes associated with the award project reference type. - AwardId:
- AwardProjectTaskBurdenSchedule
-
Parameters:
- AwardId:
$request.path.AwardId
- AwardProjectId:
$request.path.AwardProjectId
The Award Project Task Burden Schedules resource is used to view the task burden schedule of the award project. - AwardId:
Examples
The following example shows how to get an award project by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100043712585/child/AwardProject/300100043492147
Response Body Example
The following shows an example of the response body in JSON format.
{ "AwardProjectId": 300100043492147, "AwardId": 300100043712585, "AwardName": "PJC_XCC_GMS_VCO_NB Award", "AwardNumber": "PJC_XCC_GMS_VCO_NB_A", "ProjectId": 300100043492137, "ProjectName": "PJC_XCC_GMS_VCO_NB_P1", "ProjectNumber": "PJC_XCC_GMS_VCO_NB_P1", "BurdenScheduleId": null, "BurdenScheduleName": null, "BurdenScheduleFixedDate": null, "CurrencyCode": "USD", "CreatedBy": "Mark.Williams", "LastUpdateDate": "2014-08-06T23:30:00.557+00:00", "CreationDate": "2014-08-06T23:17:37+00:00", "LastUpdatedBy": "Mark.Williams" }