Get an award
get
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}
Request
Path Parameters
-
AwardId(required): integer(int64)
Unique identifier of the award.
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-item-response
Type:
Show Source
object
-
Attachment: array
Award Attachments
Title:
Award Attachments
The Award Attachments resource is used to view attachments associated with the award. -
AwardBudgetPeriod: array
Award Budget Periods
Title:
Award Budget Periods
The Award Budget Periods resource is used to view award budget period attributes such as budget period name, start date and end date. -
AwardCertification: array
Award Certifications
Title:
Award Certifications
The Award Certifications resource is used to view the certification attributes of the award. -
AwardCFDA: array
Award CFDAs
Title:
Award CFDAs
The Award CFDAs resource is used to view the attributes specific to award federal domestic assistance program. -
AwardDepartmentCredit: array
Award Department Credits
Title:
Award Department Credits
The Award Department Credits resource is used to view the organization credit attributes for the award. -
AwardError: array
Award Errors
Title:
Award Errors
The Award Errors resource is used to view validation errors associated with the award. -
AwardFunding: array
Award Fundings
Title:
Award Fundings
The Award Fundings resource is used to view award funding attributes such as funding issue type and funding issue name. -
AwardFundingSource: array
Award Funding Sources
Title:
Award Funding Sources
The Award Funding Sources resource is used to view the attributes used to create or update a funding source for the award. -
AwardHeaderDFF: array
Award Descriptive Flexfields
Title:
Award Descriptive Flexfields
A list of all the descriptive flexfields available for awards. -
AwardId: integer
(int64)
Title:
Award ID
Unique identifier of the award. -
AwardKeyword: array
Award Keywords
Title:
Award Keywords
The Award Keywords resource is used to view the keyword attributes for the award. -
AwardName: string
Title:
Award Name
Name of the award. -
AwardNumber: string
Title:
Award Number
Number of the award. -
AwardOwningOrganizationId: integer
(int64)
Title:
Award Owning Organization ID
The unique identifier of the award organization. -
AwardOwningOrganizationName: string
Title:
Award Owning Organization
Maximum Length:240
An organization that owns awards within an enterprise. An organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting for the award. -
AwardPersonnel: array
Award Personnel
Title:
Award Personnel
The Award Personnel resource is used to view the award personnel attributes such as person name, role. -
AwardProject: array
Award Projects
Title:
Award Projects
The Award Projects resource is used to view the attributes of an award project, such as project name and project number. -
AwardPurpose: string
Title:
Purpose
Maximum Length:80
Name of the award purpose. -
AwardPurposeCode: string
Title:
Purpose
Maximum Length:30
Code of the award purpose. -
AwardReference: array
Award References
Title:
Award References
The Award References resource is used to view the attributes specific to award reference type. -
AwardSource: string
Title:
Award Source
Maximum Length:20
The source from which the award is created, for example, from the UI or the REST service. -
AwardTerms: array
Award Terms
Title:
Award Terms
The Award Terms and Conditions resource is used to view the attributes of the terms and conditions associated to the award. -
AwardType: string
Title:
Type
Maximum Length:30
Classification of an award, for example, Federal grants or Private grants. -
AwardValidationNeededFlag: boolean
Indicator that specifies whether the award should be validated.
-
BillingCycle: string
Title:
Billing Cycle
Frequency at which invoices are created for the bill plan. The default value for BillingCycle is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. -
BillingCycleId: integer
Title:
Billing Cycle ID
Billing cycle represents the frequency at which invoices are created for this bill plan. -
BillPlanName: string
Title:
Bill Plan Name
Name of the bill plan associated with the contract line for the award. When the award is submitted for approval, it???s set to the default value, unless specified otherwise. The default value for BillPlanName is Award Bill Plan. -
BillSetNumber: number
The billing set number used to group invoices.
-
BillToAccountId: string
The bill-to account identifier of the customer who's responsible for receiving and paying the invoice.
-
BillToAccountNumber: string
Maximum Length:
80
The bill-to account number of the customer who's responsible for receiving and paying the invoice. -
BillToContactEmail: string
Title:
Bill-to Contact
The email of the contact person from the bill-to customer site. -
BillToContactId: string
Title:
Bill-to Contact
Unique identifier of the bill-to customer contact person on a bill plan. -
BillToContactName: string
Title:
Bill-to Contact
The contact person of the bill-to customer. -
BillToSite: string
Title:
Bill-to Site
The customer site where the invoices are sent. -
BillToSiteUseId: string
Title:
Bill-to Site
Unique identifier of the bill-to customer site that's responsible for receiving and paying the invoice amount. -
BurdenScheduleFixedDate: string
(date)
Title:
Fixed Date
Specific date used to determine the right set of burden multipliers for the award. -
BurdenScheduleId: integer
(int64)
Title:
Burden Schedule ID
Unique identifier of the burden schedule. -
BurdenScheduleName: string
Title:
Burden Schedule
Maximum Length:30
Name of the burden schedule assigned at the award level. -
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Unique identifier of the business unit. -
BusinessUnitName: string
Title:
Business Unit
Unit of an enterprise that performs one or many business functions that can be rolled up in a management hierarchy. An award business unit is one within which the award is created. -
CloseDate: string
(date)
Title:
Close Date
Date past the end date of the award. Transactions for the award can be entered up to this date. -
ContractLineName: string
Title:
Name
Name of the contract line created for the award contract. When the award is submitted for approval, it???s set to the default value, unless specified otherwise. The default value for ContractLineName is Line 1. -
ContractStatus: string
Status of the award contract. Valid values include Draft, Active, or Pending Approval. Set it to Pending Approval when submitting an award for approval using the PATCH method. If set to Active, the award is moved to the Active status.
-
ContractTypeId: integer
Title:
Contract Type ID
Unique identifier of the contract type. -
ContractTypeName: string
Title:
Contract Type
Name of the contract type of the award. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award. -
CreatedFrom: string
Title:
Created From
Maximum Length:20
The method of creating the award, for example, using 'FROM_TEMPLATE' or 'BLANK'. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award was created. -
CurrencyCode: string
Title:
Currency
Currency code representing the award currency. The currency code is a three-letter ISO code associated with a currency. -
DateChangeRequestId: integer
(int64)
Read Only:
true
The identifier of the process submitted to update the award dates and budget period dates. -
DaysToClose: integer
Title:
Days to Close
Days to close of the award. -
Description: string
Title:
Description
Maximum Length:240
Brief description of the award. -
DocumentNumber: string
Title:
Document Number
The unique identifier of the letter of credit document issued to the award. -
EndDate: string
(date)
Title:
End Date
End date of the award. -
EventFormat: string
Title:
Event Format
Name of the format that is the source of the columns, text, and layout used to group events on an invoice line. The default value for EventFormat is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. -
EventFormatId: integer
Title:
Event Format ID
The unique identifier of the format that is the source of the columns, text, and layout used to group events on an invoice line. -
ExpandedAuthorityFlag: boolean
Title:
Expanded Authority Spending Indicator
Maximum Length:1
Indicates that the award funding is authorized to be spent across budget periods. -
FederalInvoiceFormat: string
Title:
Federal Invoice Format
This field stores and indicates federal invoice format that is used for bill presentment purpose. -
FederalInvoiceFormatCode: string
Title:
Federal Invoice Format
The unique identifier of the federal invoice format that is used for bill presentment purpose. -
FlowThroughAmount: number
Amount of the flow through funds.
-
FlowThroughFederalFlag: boolean
Maximum Length:
5
Indicator that specifies whether the award project is funded by a federal agency through flow through funds. -
FlowThroughFromDate: string
(date)
Start date of the flow through funds.
-
FlowThroughPrimarySponsorId: integer
(int64)
Primary sponsor of the flow through funds.
-
FlowThroughPrimarySponsorName: string
Title:
Flow-Through Funds Primary Sponsor
Name of the primary sponsor of the flow through funds. -
FlowThroughPrimarySponsorNumber: string
Title:
Flow-Through Funds Primary Sponsor
Number of the primary sponsor of the flow through funds. -
FlowThroughReferenceAwardName: string
Maximum Length:
100
Name of the flow through reference award. -
FlowThroughToDate: string
(date)
End date of the flow through funds.
-
GeneratedInvoiceStatus: string
Title:
Generated Invoice Status
Status set during the Generate Invoice process. Valid values are Draft, Submitted, or Released. -
GeneratedInvoiceStatusCode: string
Title:
Generated Invoice Status
Lookup code for the Generated Invoice Status. Valid values are D,S,or R. -
InstitutionComplianceApprovalDate: string
(date)
Approval date for the conflict of interest indicator.
-
InstitutionComplianceFlag: boolean
Maximum Length:
5
The conflict of interest indicator that specifies whether the award project complies with Institution policy. -
InstitutionComplianceReviewCompletedFlag: boolean
Maximum Length:
5
The conflict of interest indicator that specifies whether compliance review is completed. -
InstitutionId: integer
(int64)
Title:
Institution ID
The unique identifier of the institution. -
InstitutionName: string
Title:
Institution
Organizational entity that is receiving the funding. -
IntellectualPropertyDescription: string
Maximum Length:
200
Description of the intellectual property. -
IntellectualPropertyReportedFlag: boolean
Maximum Length:
5
Indicates whether intellectual property is reported. -
InvoiceGrouping: string
Title:
Invoice Grouping
The name of the invoice grouping method. -
InvoiceGroupingCode: string
Title:
Invoice Grouping
The code of the invoice grouping method. -
InvoiceMethod: string
Title:
Invoice Method
Name of the method to calculate invoice amounts for the bill plan associated with the contract line for the award project. The default value for InvoiceMethod is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. -
InvoiceMethodId: integer
Title:
Invoice Method ID
The unique identifier of the method to calculate invoice amounts for the bill plan associated with the contract line for this award project. -
LaborFormat: string
Title:
Labor Format
Name of the format that is the source of the columns, text, and layout used to group labor items on an invoice line. The default value for LaborFormat is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. -
LaborFormatId: integer
Title:
Labor Format ID
The unique identifier of the labor format that is the source of the columns, text, and layout used to group labor items on an invoice line. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award. -
LastValidated: string
(date-time)
Title:
Last Validated
The date when the award is last validated. -
LegalEntityId: integer
Title:
Legal Entity ID
Unique identifier of the legal entity of the award. -
LegalEntityName: string
Title:
Legal Entity
Recognized party with given rights and responsibilities by legislation. Owns the award being displayed. -
LetterOfCreditFlag: boolean
Title:
Letter of credit
Indicates whether the award is issued under a letter of credit. If the award sponsor is a Federal and Letter of Credit sponsor, then the default value is true. Otherwise, the default value is false. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NetInvoiceFlag: boolean
Title:
Net Invoice
Indicates whether net invoicing is set on the contract. -
NonLaborFormat: string
Title:
Nonlabor Format
Name of the format that is the source of the columns, text, and layout used to group nonlabor items on an invoice line. The default value for NonLaborFormat is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. -
NonLaborFormatId: integer
Title:
Nonlabor Format ID
The unique identifier of the format that is the source of the columns, text, and layout used to group nonlabor items on an invoice line. -
PaymentTerms: string
Title:
Payment Terms
Terms used to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice. The default value for PaymentTerms is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. -
PaymentTermsId: integer
Title:
Payment Terms ID
The unique identifier of the terms used to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice. -
PreAwardDate: string
(date)
Title:
Pre-Award Date
Date before the start date of an award. -
PreAwardGuaranteedFundingSource: string
Maximum Length:
100
The guaranteed source of funding for the award. -
PreAwardSpendingAllowedFlag: boolean
Maximum Length:
5
Flag indicating whether pre-award spending is allowed. -
PreviousAwardAccomplishmentRenewFlag: boolean
Maximum Length:
5
The flag that indicates accomplishment-based renewal from the previous award. -
PreviousAwardBUId: integer
(int64)
Title:
Previous Award Business Unit
The unique internal identifier of a previous award business unit. -
PreviousAwardBUName: string
Title:
Previous Award Business Unit
Name of the business unit of the previous award. -
PreviousAwardId: integer
(int64)
Title:
Previous Award Name
The unique internal identifier of a previous award. -
PreviousAwardInProgressRenewFlag: boolean
Maximum Length:
5
Indicates whether renewal of the previous award is in progress. -
PreviousAwardName: string
Title:
Previous Award Name
Name of the previous award. -
PreviousAwardNumber: string
Title:
Previous Award Name
Number of the previous award. -
PrincipalInvestigatorEmail: string
Title:
Principal Investigator Email
E-mail of the person selected from Human Resources to administer and manage awards. -
PrincipalInvestigatorId: integer
Title:
Principal Investigator ID
The unique identifier of the person, in human resources, identified as the principal investigator. -
PrincipalInvestigatorName: string
Title:
Principal Investigator Name
Name of the person selected from Human Resources to administer and manage awards. -
PrincipalInvestigatorNumber: string
Title:
Principal Investigator Number
Number of the person selected from Human Resources to administer and manage awards. -
RevenueMethod: string
Title:
Revenue Method
Name of the method used to calculate revenue amounts for the revenue plan associated with the contract line for the award project. The default value for RevenueMethod is set to the value specified in the Manage Grants Business Unit Implementation Options page in the Setup and Maintenance work area. -
RevenueMethodId: integer
Title:
Revenue Method ID
The unique identifier of the method used to calculate revenue amounts for the revenue plan associated with the contract line for this award project. -
RevenuePlanName: string
Title:
Revenue Plan Name
Name of the revenue plan associated with the contract line for the award. When the award is submitted for approval, it???s set to the default value, unless specified otherwise. The default value for RevenuePlanName is Award Revenue Plan. -
ShipToAccountId: string
The ship-to account identifier of the customer who receives the goods and services.
-
ShipToAccountNumber: string
Maximum Length:
80
The ship-to account number of the customer who receives the goods and services. -
ShipToSite: string
Title:
Ship-to Site
The ship-to site. -
ShipToSiteUseId: string
Title:
Ship-to Site
The unique identifier of the ship-to site. -
SourceAwardName: string
Title:
Source Award
Read Only:true
Maximum Length:300
Name of the source award. -
SourceTemplateId: integer
(int64)
Title:
Source Template ID
Unique identifier of the source award template. -
SourceTemplateName: string
Title:
Source Template Name
Name of the source award template. -
SourceTemplateNumber: string
Title:
Source Template Number
Number of the source award template. -
SponsorAwardNumber: string
Title:
Sponsor Award Number
Maximum Length:30
Award number tracked by the sponsor. -
SponsorId: integer
(int64)
Title:
Sponsor ID
Unique identifier of the primary sponsor. -
SponsorName: string
Title:
Sponsor Name
Name of the sponsor, who is also the customer, funding the award. -
SponsorNumber: string
Title:
Sponsor Number
Number of the sponsor related to the customer from TCA. -
StartDate: string
(date)
Title:
Start Date
Start date of the award. -
TransactionTypeId: string
Title:
Transaction Type
Unique identifier of the Receivables Transaction Type for invoices and credit memos. -
TransactionTypeName: string
Title:
Transaction Type
Receivables transaction type for invoices and credit memos. -
ValidateStatus: string
Maximum Length:
1
Default Value:N
Indicator that specifies the validation status of an award .
Nested Schema : Award Attachments
Type:
array
Title:
Award Attachments
The Award Attachments resource is used to view attachments associated with the award.
Show Source
Nested Schema : Award Budget Periods
Type:
array
Title:
Award Budget Periods
The Award Budget Periods resource is used to view award budget period attributes such as budget period name, start date and end date.
Show Source
Nested Schema : Award Certifications
Type:
array
Title:
Award Certifications
The Award Certifications resource is used to view the certification attributes of the award.
Show Source
Nested Schema : Award CFDAs
Type:
array
Title:
Award CFDAs
The Award CFDAs resource is used to view the attributes specific to award federal domestic assistance program.
Show Source
Nested Schema : Award Department Credits
Type:
array
Title:
Award Department Credits
The Award Department Credits resource is used to view the organization credit attributes for the award.
Show Source
Nested Schema : Award Errors
Type:
array
Title:
Award Errors
The Award Errors resource is used to view validation errors associated with the award.
Show Source
Nested Schema : Award Fundings
Type:
array
Title:
Award Fundings
The Award Fundings resource is used to view award funding attributes such as funding issue type and funding issue name.
Show Source
Nested Schema : Award Funding Sources
Type:
array
Title:
Award Funding Sources
The Award Funding Sources resource is used to view the attributes used to create or update a funding source for the award.
Show Source
Nested Schema : Award Descriptive Flexfields
Type:
array
Title:
Award Descriptive Flexfields
A list of all the descriptive flexfields available for awards.
Show Source
Nested Schema : Award Keywords
Type:
array
Title:
Award Keywords
The Award Keywords resource is used to view the keyword attributes for the award.
Show Source
Nested Schema : Award Personnel
Type:
array
Title:
Award Personnel
The Award Personnel resource is used to view the award personnel attributes such as person name, role.
Show Source
Nested Schema : Award Projects
Type:
array
Title:
Award Projects
The Award Projects resource is used to view the attributes of an award project, such as project name and project number.
Show Source
Nested Schema : Award References
Type:
array
Title:
Award References
The Award References resource is used to view the attributes specific to award reference type.
Show Source
Nested Schema : Award Terms
Type:
array
Title:
Award Terms
The Award Terms and Conditions resource is used to view the attributes of the terms and conditions associated to the award.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-Attachment-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-AwardBudgetPeriod-item-response
Type:
Show Source
object
-
AwardBudgetPeriodId: integer
(int64)
Title:
Budget Period ID
The unique identifier of the award budget period. -
AwardId: integer
(int64)
Title:
Award ID
The unique internal identifier of the award. -
BudgetPeriod: string
Title:
Name
Maximum Length:15
The time interval assigned to the award for which the budget, actual, commitment, and available amount are shown. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award budget period. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award budget period was created. -
EndDate: string
(date)
Title:
End Date
End date of the budget period for the award. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award budget period was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award budget period. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StartDate: string
(date)
Title:
Start Date
Start date of the budget period for the award.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardCertification-item-response
Type:
Show Source
object
-
ApprovalDate: string
(date)
Title:
Approval Date
The approval date of the Certification. -
AssuranceNumber: string
Title:
Assurance Number
Maximum Length:20
Assurance of compliance number. Indicates whether the organization complies with the regulations for the protection of animal or human research subjects. -
AwardCertificationId: integer
(int64)
The unique identifier of the award certification.
-
AwardId: integer
(int64)
Title:
Award ID
The unique internal identifier of the award. -
CertificationDate: string
(date)
Title:
Certification Date
The date of Certification. -
CertificationId: integer
(int64)
Title:
Certification ID
The unique identifier of certification. -
CertificationName: string
Title:
Certification Name
Maximum Length:80
The name of the Award Certifications. -
CertifiedByPersonId: integer
(int64)
Title:
Certified By
The unique ID of the person who gave the Certification. -
CertifiedByPersonName: string
Title:
Certified By
Maximum Length:240
The name of the person who gave the Certification. -
Comments: string
Title:
Comments
Maximum Length:4000
The Award Certification Comment. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award certification. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award certification was created. -
ExemptionNumber: string
Title:
Exemption Number
Maximum Length:20
Number that determines whether the research involves more than minimal risk and meets the criteria specified by federal regulations, and therefore, is exempt from protocol approvals. -
ExpeditedReviewFlag: boolean
Title:
Expedited Review
Maximum Length:1
The Expediated Review indicator of the Certification. -
ExpirationDate: string
(date)
Title:
Expiration Date
The Expiration Date of the Certification. -
FullReviewFlag: boolean
Title:
Full Review
Maximum Length:1
Indicates whether the award certification requires a full review. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award certification was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award certification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Status: string
Title:
Status
Maximum Length:80
The status of the Certification.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardCFDA-item-response
Type:
Show Source
object
-
AwardCFDAId: integer
(int64)
Title:
ALN ID
The unique identifier of the federal domestic assistance program associated with the award. -
AwardId: integer
(int64)
Title:
Award ID
The unique internal identifier of the award. -
Cfda: string
Title:
Assistance Listing Numbers
Maximum Length:30
Number used to identify the nature of federal funding received in the form of award from sponsors. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award CFDA. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award CFDA was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award CFDA was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award CFDA. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramTitle: string
Title:
Name
Read Only:true
Maximum Length:255
Name of the federal domestic assistance program.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardDepartmentCredit-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
The unique internal identifier of the award. -
AwardOrganizationCreditId: integer
(int64)
Title:
Award Organization Credit
The unique Identifier of Award Organization Credit. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award department credit. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award department credit was created. -
CreditPercentage: number
Title:
Organization Credit Percentage
The credit percentage value of Award Organization Credit. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award department was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award department credit. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Title:
Organization ID
The unique internal identifier of the Organization. -
OrganizationName: string
Title:
Organization
Maximum Length:240
The name of the Organization.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardError-item-response
Type:
Show Source
object
-
AwardErrorId: integer
(int64)
The unique identifier of the award error.
-
AwardId: integer
(int64)
The unique internal identifier of the award.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award error. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award error was created. -
ErrorCode: string
Maximum Length:
30
The identifier of the error code. -
ErrorType: string
Maximum Length:
1
The identifier of the error type. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award error was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award error. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageText: string
Read Only:
true
The error message to be displayed. -
MessageUserDetails: string
Read Only:
true
Maximum Length:4000
Additional information about the cause and resolution of the error.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardFunding-item-response
Type:
Show Source
object
-
AwardFundingId: integer
(int64)
Title:
Award Funding ID
Unique identifier of the award funding. -
AwardFundingSourceId: integer
(int64)
Title:
Award Funding Source ID
Unique identifier of the award funding source. -
AwardId: integer
(int64)
Title:
Award ID
Unique identifier of the award. -
AwardProjectFunding: array
Award Project Fundings
Title:
Award Project Fundings
The Award Project Fundings resource is used to view funding allocation attributes for the award project. -
BudgetPeriod: string
Name of the budget period for the award.
-
BudgetPeriodId: integer
(int64)
Title:
Budget Period ID
Unique identifier of the award budget period. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award funding. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award funding was created. -
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:15
Currency code representing the award currency. The currency code is a three-letter ISO code associated with a currency. -
DirectFundingAmount: number
Title:
Direct Funding Amount
Total funding amount granted for the award. -
FundingIssueDate: string
(date)
Title:
Date
Date when the funding was issued. -
FundingIssueDescription: string
Title:
Description
Maximum Length:240
Description of the funding issue. -
FundingIssueNumber: string
Title:
Number
Maximum Length:200
Number of the funding issue. -
FundingIssueType: string
Title:
Type
Maximum Length:30
Type code of funding issued, for example BASE or SUPPLEMENT. -
FundingIssueTypeName: string
Title:
Award Funding Issue Type
Maximum Length:80
Type of funding issued, for example Base or Supplement. -
FundingSourceId: integer
(int64)
Title:
Funding Source ID
Unique identifier of the funding source. -
FundingSourceName: string
Title:
Funding Source Name
Maximum Length:360
Name of the funding source. -
FundingSourceNumber: string
Title:
Funding Source Number
Maximum Length:50
Number of the funding source, entered by the user. -
IndirectFundingAmount: number
Title:
Indirect Funding Amount
Burden amount granted by the sponsor as part of funding amount. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award funding was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award funding. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Award Project Fundings
Type:
array
Title:
Award Project Fundings
The Award Project Fundings resource is used to view funding allocation attributes for the award project.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardFunding-AwardProjectFunding-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
Unique identifier of the award. -
AwardProjectFundingId: integer
(int64)
Title:
Award Project Funding ID
Unique identifier of the award project funding allocation. -
AwardProjectLinkId: integer
(int64)
Title:
Award Project Link ID
Unique identifier of the award project. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award project funding allocation. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award project funding allocation was created. -
CurrencyCode: string
Title:
Currency
Read Only:true
Currency code representing the award currency. The currency code is a three-letter ISO code associated with a currency. -
FundingAmount: number
Title:
Funding Amount
Funding amount allocated to the award project. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award project funding allocation was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award project funding allocation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectId: integer
Title:
Project ID
Unique identifier of the award project. -
ProjectName: string
Title:
Project Name
Name of the project to which the funding is allocated. -
ProjectNumber: string
Title:
Project Number
Number of the project to which the funding is allocated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardFundingSource-item-response
Type:
Show Source
object
-
ApprovalDate: string
(date)
Title:
Approval Date
The approval date of the selected award funding source. -
ApprovalPersonId: integer
(int64)
Title:
Approved By
The unique identifier of the person who approved the selected funding source. -
ApprovalPersonName: string
Title:
Approved By
Maximum Length:240
The name of the person who approved the selected funding source. -
ApprovalPersonNumber: string
Title:
Approval Person Number
Maximum Length:30
The number of the person who approved the selected funding source. -
AwardFundingSourceSourceId: integer
(int64)
Title:
Award Funding Source ID
The unique identifier of the award funding source association. -
AwardId: integer
(int64)
Title:
Award ID
The unique identifier of the award. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award funding source. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award funding source was created. -
FundingSourceId: integer
(int64)
Title:
Funding Source ID
The unique identifier of the selected funding source. -
FundingSourceName: string
Title:
Name
Maximum Length:360
The name of the selected funding source. -
FundingSourceNumber: string
Title:
Number
Maximum Length:50
The unique number associated with the selected funding source. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award funding source was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award funding source. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RequiredBySponsor: string
Title:
Required By Sponsor
Maximum Length:1
Indicates whether the selected funding source is marked as required by sponsor. -
Type: string
Title:
Type
Read Only:true
Maximum Length:1
The type of the selected award funding source.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardHeaderDFF-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-AwardKeyword-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
The unique identifier for Award. -
AwardKeywordId: integer
(int64)
Title:
Award Keyword
The unique identifier for Award Keyword. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award keyword. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award keyword was created. -
KeywordId: integer
(int64)
Title:
Keyword ID
The unique identifier for Keyword. -
KeywordName: string
Title:
Name
The name of the keyword. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award keyword was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award 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-AwardPersonnel-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
The unique identifier of the award. -
AwardPersonnelDFF: array
Award Personnel Descriptive Flexfields
Title:
Award Personnel Descriptive Flexfields
A list of all the descriptive flexfields available for award personnel. -
AwardPersonnelId: integer
(int64)
Title:
Award Personnel
The unique identifier for award personnel association. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award personnel. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award personnel was created. -
CreditPercent: number
Credit percentage value associate for the selected person.
-
EmailAddress: string
Title:
Email
Email Address for the selected person from Human Resources. -
EndDate: string
(date)
Title:
End Date
End date of the duration for the award person associateion. -
InternalFlag: boolean
Title:
Internal
Maximum Length:1
Default Value:true
Indicates whether the selected person is internal or external. -
JobTitle: string
Title:
Primary Job
Job Title of the person selected from Human Resources. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award personnel was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award personnel. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Title:
Primary Organization
Name of the Organization of the selected person. -
PartyId: integer
(int64)
The unique identifier of the selected external person.
-
PersonId: integer
(int64)
The unique identifier of the selected internal person from Human Resources.
-
PersonName: string
Title:
Person Name
Name of the person in HCM. -
PersonNumber: string
Title:
Person Number
Person number of the person. -
PhoneNumber: string
Title:
Phone
Phone number of the person selected from Human Resources to administer and manage awards. -
Role: string
Title:
Role
Maximum Length:240
The role performed by the selected person. -
RoleId: integer
(int64)
Unique identifier of the selected role of the person.
-
StartDate: string
(date)
Title:
Start Date
Start date of the duration for the award person association.
Nested Schema : Award Personnel Descriptive Flexfields
Type:
array
Title:
Award Personnel Descriptive Flexfields
A list of all the descriptive flexfields available for award personnel.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardPersonnel-AwardPersonnelDFF-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-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 : 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
Nested Schema : awards-AwardReference-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
The unique identifier of the award. -
AwardReferenceId: integer
(int64)
The unique identifier of the award reference.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award reference. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award reference was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Description for the award reference. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award reference was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award reference. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReferenceComment: string
Title:
Comments
Maximum Length:4000
Comments given for the award reference. -
ReferenceId: integer
(int64)
Title:
Reference ID
Unique identifier of the selected reference. -
ReferenceTypeName: string
Title:
Reference Type Name
Maximum Length:80
The name of the type of the selected reference. -
ReferenceValue: string
Title:
Value
Maximum Length:300
The value set for the reference.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardTerms-item-response
Type:
Show Source
object
-
AwardId: integer
(int64)
Title:
Award ID
The unique identifier of Award. -
AwardTermsId: integer
(int64)
The unique identifier of Award Terms and Conditions.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user that created the award terms. -
CreationDate: string
(date-time)
Read Only:
true
The date when the award terms was created. -
Description: string
Title:
Description
Maximum Length:240
Award Terms and Conditions description. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the award term was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user that last updated the award terms. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TermsCategoryId: integer
(int64)
The unique identifier of Term and Conditions Category.
-
TermsCategoryName: string
Title:
Terms and Conditions Category
Maximum Length:80
The terms and Conditions Category name. -
TermsId: integer
(int64)
Title:
Term ID
Unique identifier of Terms and Conditions. -
TermsName: string
Title:
Terms and Conditions Name
Maximum Length:80
Terms and Conditions Name. -
TermsOperator: string
Title:
Operator
Maximum Length:40
Terms and Conditions Operator. -
TermsValue: string
Title:
Value
Maximum Length:20
Terms and Conditions Term value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Attachment
-
Parameters:
- AwardId:
$request.path.AwardId
The Award Attachments resource is used to view attachments associated with the award. - AwardId:
- AwardBudgetPeriod
-
Parameters:
- AwardId:
$request.path.AwardId
The Award Budget Periods resource is used to view award budget period attributes such as budget period name, start date and end date. - AwardId:
- AwardCFDA
-
Parameters:
- AwardId:
$request.path.AwardId
The Award CFDAs resource is used to view the attributes specific to award federal domestic assistance program. - AwardId:
- AwardCertification
-
Parameters:
- AwardId:
$request.path.AwardId
The Award Certifications resource is used to view the certification attributes of the award. - AwardId:
- AwardDepartmentCredit
-
Parameters:
- AwardId:
$request.path.AwardId
The Award Department Credits resource is used to view the organization credit attributes for the award. - AwardId:
- AwardError
-
Parameters:
- AwardId:
$request.path.AwardId
The Award Errors resource is used to view validation errors associated with the award. - AwardId:
- AwardFunding
-
Parameters:
- AwardId:
$request.path.AwardId
The Award Fundings resource is used to view award funding attributes such as funding issue type and funding issue name. - AwardId:
- AwardFundingSource
-
Parameters:
- AwardId:
$request.path.AwardId
The Award Funding Sources resource is used to view the attributes used to create or update a funding source for the award. - AwardId:
- AwardHeaderDFF
-
Parameters:
- AwardId:
$request.path.AwardId
A list of all the descriptive flexfields available for awards. - AwardId:
- AwardKeyword
-
Parameters:
- AwardId:
$request.path.AwardId
The Award Keywords resource is used to view the keyword attributes for the award. - AwardId:
- AwardPersonnel
-
Parameters:
- AwardId:
$request.path.AwardId
The Award Personnel resource is used to view the award personnel attributes such as person name, role. - AwardId:
- AwardProject
-
Parameters:
- AwardId:
$request.path.AwardId
The Award Projects resource is used to view the attributes of an award project, such as project name and project number. - AwardId:
- AwardReference
-
Parameters:
- AwardId:
$request.path.AwardId
The Award References resource is used to view the attributes specific to award reference type. - AwardId:
- AwardTerms
-
Parameters:
- AwardId:
$request.path.AwardId
The Award Terms and Conditions resource is used to view the attributes of the terms and conditions associated to the award. - AwardId:
Examples
The following example shows how to get an award 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
Response Body Example
The following shows an example of the response body in JSON format.
{ "AwardId": 300100043712585, "AwardName": "PJC_XCC_GMS_VCO_NB Award", "AwardNumber": "PJC_XCC_GMS_VCO_NB_A", "BusinessUnitId": 300100014554154, "BusinessUnitName": "Vision City Operations", "CurrencyCode": "USD", "LegalEntityId": 300100014516903, "LegalEntityName": "Vision City LE", "SponsorId": 300100038787368, "SponsorName": "Dept of Health and Human Services (DHHS)", "SponsorNumber": "CDRM_70255", "StartDate": "2011-10-01", "EndDate": "2016-09-30", "PrincipalInvestigatorId": 300100026354758, "PrincipalInvestigatorName": "phil Williams", "PrincipalInvestigatorNumber": null, "PrincipalInvestigatorEmail": null, "ExpandedAuthorityFlag": true, "BurdenScheduleId": 300100038787360, "BurdenScheduleName": "Award Burden Schedule", "BurdenScheduleFixedDate": null, "ContractTypeName": null, "CloseDate": "2016-10-30", "AwardType": null, "DaysToClose": null, "AwardStatus": "Expired", "SponsorAwardNumber": null, "AwardOwningOrganizationId": 300100014554154, "AwardOwningOrganizationName": "Vision City Operations", "AwardPurposeCode": null, "AwardPurpose": null, "Description": null, "SourceAwardName": null, "InstitutionId": 300100039540628, "InstitutionName": "Steffon University", "ContractLineName": "Line 1", "DocumentNumber": "PJC_XCC_GMS_DOC_01", "LetterOfCreditFlag": true, "RevenuePlanName": "Award Revenue Plan", "BillPlanName": "Award Bill Plan", "LaborFormatId": 7004, "LaborFormat": "Contract Line Project/Task Emp", "EventFormatId": 100000011213026, "EventFormat": "Cont Line Project/Task Event", "NonLaborFormatId": 7005, "NonLaborFormat": "Contract Line Project/Task Exp", "RevenueMethodId": 300100039542367, "RevenueMethod": "Cost Reimbursible Method", "PaymentTermsId": 5, "PaymentTerms": "IMMEDIATE", "BillingCycleId": 1000000000003, "BillingCycle": "Monthly", "InvoiceMethodId": 100000015590467, "InvoiceMethod": "As Incurred Method", "FederalInvoiceFormat": null, "FederalInvoiceFormatCode": null, "ContractTypeId": null, "ContractStatus": null, "CreatedBy": "Mark.Williams", "CreationDate": "2014-08-06T23:09:34+00:00", "LastUpdatedBy": "Mark.Williams", "LastUpdateDate": "2014-08-06T23:40:46.210+00:00", "InstitutionComplianceApprovalDate": null, "InstitutionComplianceFlag": null, "InstitutionComplianceReviewCompletedFlag": null, "FlowThroughFromDate": null, "FlowThroughToDate": null, "FlowThroughFederalFlag": null, "FlowThroughPrimarySponsorId": null, "FlowThroughPrimarySponsorName": null, "FlowThroughPrimarySponsorNumber": null, "FlowThroughReferenceAwardName": null, "FlowThroughAmount": null, "PreviousAwardBUId": null, "PreviousAwardBUName": null, "PreviousAwardId": null, "PreviousAwardName": null, "PreviousAwardNumber": null, "PreviousAwardInProgressRenewFlag": null, "PreviousAwardAccomplishmentRenewFlag": null, "IntellectualPropertyDescription": null, "IntellectualPropertyReportedFlag": null, "PreAwardSpendingAllowedFlag": null, "PreAwardGuaranteedFundingSource": null, "PreAwardDate": null, "ValidateStatus": "W", "AwardValidationNeeded": 0, "LastValidated": "2014-08-06T23:40:46.388+00:00" }