Invention API Reference

The Invention API allows an organization users create, update and search for an invention record owned by the user’s affiliated organization and with any agency as the Primary Agency. Agency users can create, update, and search an invention record owned by any institution and with the user’s affiliated agency as Primary Agency.

The following changes were made to Version 2 (v2):

Renamed the attribute ‘isInventionUnderFundingAgreement’ to ‘isExceptionCircumstanceDetermination’ in invention request and invention response data object
Added ‘id’ attribute to the invention response for ‘invention’, ‘inventor’, ‘fundingAgreement’, ‘subContractInfo’, ‘explanatoryNote’, and ‘governmentNote’ JSON objects.

Note: Create Invention, Version 1 (v1) will no longer be supported after July 18th, 2025.

Create Invention, v2

The Create Invention API allows an organization/agency to create an Invention Report. Refer to Appendix A for samples of requests and responses.

Endpoint URI

This is an example of the endpoint for the Create Invention resource.

POST /iedison/api/v2/inventions/create

Request Parameters

The request has the following elements:

Headers: These are the request headers such as Accept and Content-Type. The Accept header defines the expected response format when the API returns the response. The Accept header is required for all requests.

Body: The body contains the data that will be submitted as the POST request. When submitting a form, the format data and file content are sent in the body of the request.

The table below provides a description of the Create Invention request header and body parameters that are expected by the iEdison API.

Request Parameter	Description	Required	Data Type	Version	In
accept	Specifies the response format that is expected. Set to “application/json”.	Yes	String	v1+	header
inventionRequest	The JSON object that contains attributes used in the request. Refer to the table below for a description of the attributes.	Yes	String	v1+	form-data
inventionDisclosure	Invention Disclosure document contains the written description of the Invention, a signed copy of the government Confirmatory License, and the Government Support Clause which is in a Patent or Patent application. The following file types are allowed for the Invention Disclosure document: CSV, GIF, JPEG, JPG, PNG, PDF, DOCX, DOC, TIFF, TIF, TXT, XLS, XLSX, PPT, PPTX, ODT, and RTF. The maximum file size is 50MB.	Yes	Binary Attachment	v1+	form-data

The table below lists the attributes that will be included in the inventionRequest parameter when creating an Invention Report. The attributes are included in the JSON object as part of the inventionRequest form-data text element.

JSON Attribute Name	Description	Required	Data Type	Length	Version
granteeOrganizationName	The name of the organization established at registration. This field is no longer used in the request. The system is using the institutionCode instead. If value is provided, the system will ignore it.	No	String	100	v1+
institutionCode	The unique code assigned to the reporting organizations.	Yes	String	10	v1+
dunsNumber	The Data Universal Numbering System (DUNS) number provided by Dun & Bradstreet that identifies the grantee/contractor. This field is no longer used in the request. If value is provided for this field, the system will ignore it.	No	String	9	v1+
inventionTitle	The title of the Invention as it appears in the grantee/contractors employee’s Invention Report.	Yes	String	255	v1+
inventionDocketNumber	An internal reference number of the grantee/contractor organization to help track a reported Invention(s). If no value is provided for this field, the system will generate one for the invention.	No	String	30	v1+
doesNumber	The DOE S-number is assigned to each DOE Invention. The number is mainly used in DOE’s Invention tracking system. This field is used by agency system users in invention create request only. If organization client submit a create invention request with this value, the system will ignore the value.	No	String	15	v1+
parentInventionNumber	Invention Report number used when an Invention is combined into another Invention as a parent Invention.	No	String	25	v1+
inventionReportDate	The date the inventor disclosed the subject Invention in writing to the recipient institution. Format: MM/DD/YYYY	Yes	String	10	v1+
firstPublicationDate	The date of first publication, on sale, or public use initiating the one-year statutory period wherein valid Patent protection can still be obtained in the United States. Format: MM/DD/YYYY	No	String	10	v1+
keywords	Any keywords used to identify or categorize your invention.	No	Array [String]	80	v1+
doeWaiver	Refers to the government’s waiver of rights under 10 CFR 784 in an invention arising from DOE-funded research so that private entities may expedite commercialization, quickly bringing their technologies from lab to market. There are three types of waivers: Advance, Identified, and Class patent waivers.	No	String		v1+
institutionCodeForOtherInstitutions	The Institution Code for other organizations to view Inventions and other related parents. A maximum of three additional iEdison registered organizations may be granted view-only access to an Invention Report.	No	Array [String]		v1+
isExceptionCircumstanceDetermination	Is this invention made under a funding agreement subject to a determination of exceptional circumstances? If value is not provided, the system will set it to ‘false’.	No	Boolean		v2+
Inventors	List of Inventors
	Persons considered “inventors” of this invention in the Invention Report.		Array [JSON Object]		v1+
firstName	The first name of the inventor.	Yes	String	80	v1+
lastName	The last name of the inventor.	Yes	String	80	v1+
middleInitial	The middle name or first initial of the inventor.	No	String	30	v1+
fedEmployee	Is the inventor a federal employee? true = federal employee, false = not a federal employee (default)	No	Boolean		v1+
fedAgency	If the inventor is a federal employee, the agency the inventor works for. Click here for a list of valid abbreviations.	No	String	80	v1+
primaryAgency	The Primary Agency designated for each Invention Report in iEdison. Click here for a list of valid abbreviations.	Yes	String	50	v1+
bayhDoleActVersion	The Bayh Dole Act Version for the Invention. This allows 1980 or 2018. Default = 2018	No	Integer		v1+
fundingAgreements	The funding agreement is identified and reported in two parts, the Agency Designation (the acronym for the Federal Agency name) and the grant or contract award number corresponding to the agency that contributed to the Invention.	Yes	Array [JSON Object]		v1+
agency	The federal government agency that made the award that was used to support the conception of the Invention or its first actual reduction to practice. Click here for a list of valid abbreviations.	Yes	String	80	v1+
grantNumber	The corresponding grant or contract number. The format of the grant or contract number is specified by the associated agency.	Yes	String	40	v1+
awardType	Indicates the type of award as a primary award or a sub-award. Refer to Section 12.3 for a list of valid values.	No	String	5	v1+
agreementType	Indicates the type of agreement. Refer to Section 12.1 for a list of valid values.	No	String	80	v1+
subContractInfos	Subcontractor Information	No	Array [JSON Object]		v1+
subContractNumber	An additional grant or contract number for an Invention or Patent.	Yes	String	150	v1+
contractorName	The name of the subcontractor that provided the grant or contract.	No	String	120	v1+
contractorDUNS	The DUNS number of the subcontractor that provided the grant or contract. This field had be replaced by contractorUei.	No	String	9	v1+
contractorUei	The UEI number of the subcontractor that provided the grant or contract.	No	String	12	v3+
contractorCity	The city of the subcontractor that provided the grant or contract.	No	String	35	v1+
contractorState	The state of the subcontractor that provided the grant or contract. Refer to Section 12.14 for a list of valid values.	No	String	2	v1+
contractorCountry	The country name of the subcontractor that provided the grant or contract. Refer to Section 12.4 for a list of valid values.	No	String	15	v1+
inventionStatus	Title Election and Disposition Status group	Yes	JSON Object		v1+
titleElectionStatus	Organization’s decision regarding the election of title for this invention. Only “Under Evaluation” or “Elect to Retain Title” is allowed in the creation invention API request.	Yes	String	80	v1+
titleElectionDate	The legally binding date that the grantee/contractor elected to retain title to an Invention. This field will be ignored by the system for Organization client since it is automatically generated when organization client submits an Invention API request with “Elect to Retain Title” Status. Format: MM/DD/YYYY	No	String	10	v1+
notElectTitleReason	This field is for the grantee/contractor to select the reason for titleElectionStatus is ‘Does Not Retain Title’ in an Invention Report. Refer to Section 12.15 for a list of valid values. This field will be ignored in the create Invention API request since system only allow organization to submit a create invention API request with titleElectionStatus as “Under Evaluation” or “Elect to Retain Title”.	No	String	255	v1+
notElectTitleOtherReason	If the titleElectionStatus is ‘Does Not Retain Title’ and notElectTitleReason is ‘Other’, this field is used to provide the description of the custom reason for not electing title. This field will be ignored in the create Invention API request since system only allow organization to submit a create invention API request with titleElectionStatus as “Under Evaluation” or “Elect to Retain Title”.	No	String	255	v1+
doesNotRetainTitleDate	The date the grantee/contractor chose to Not Elect Title or retain Title in an Invention Report. This field will be ignored in the create Invention API request since system only allow organization to submit a create invention API request with titleElectionStatus as “Under Evaluation” or “Elect to Retain Title”. Format: MM/DD/YYYY	No	String	10	v1+
dispositionStatus	The government’s decision on the disposition of rights. This field is for agency users to update the disposition of rights. This field will be ignored in the create Invention API request.	No	String	80	v1+
dispositionRightsDate	The date the government decided on the disposition of rights. This field is for agency users to update the disposition of rights. This field will be ignored in the create Invention API request. Format: MM/DD/YYYY	No	String	10	v1+
explanatoryNotes	Explanatory notes are used to note information about an Invention Report or Patent Report.	No	JSON Object		v1+
note	Explanatory notes are used to note information about an Invention Report or Patent Report. Explanatory notes should not be used for data that is provided by other iEdison data fields.	Yes	String	500	v1+
governmentNotes	Government Notes	No	JSON Object		v1+
	This is for agency users only. If this is provided by organization client, the system will ignore it.
note	Government Notes are used to note information about an Invention Report or Patent Report by federal users who have access to view the record.	Yes	String	500	v1+
budgetIdentifiers	This contains a list of Budget Identifiers for the Invention Report.	No	Array [String]		v1+
agencyCustom1	The agency custom note field. Only available for agency users. If organization client provides a value for this field, the system will ignore it.	No	String	2000	v1+
agencyCustom2	The agency custom note field. Only available for agency users. If organization client provides a value for this field, the system will ignore it.	No	String	2000	v1+
agencyCustom3	The agency custom note field. Only available for agency users. If organization client provides a value for this field, the system will ignore it.	No	String	2000	v1+
governmentStaff	Used to identify government staff. This field will be ignored in the create Invention API request.	No	String	200	v1+
governmentCounsel	Used to identify the Government Counsel (law firm) for an Invention Report. This field will be ignored in the create Invention API request.	No	String	200	v1+

Response Parameters

When the request is processed and the Invention Report is successfully created, the Create Invention API endpoint returns an inventionResponse data object. The attributes of this object are described in Section 7.4.

Update Invention, v2

The Update Invention API allows organization users to update an existing Invention Reports owned by the user’s affiliated organization. Agency users can update Invention Reports with one or more funding agreements provided by the user’s affiliated agency. Refer to Appendix A for samples of requests and responses.

Endpoint URI

This is an example of the endpoint for the Update Invention resource.

POST /iedison/api/v2/inventions/update

Request Parameters

The API POST request has the following elements:

Headers: These are the request headers such as Accept or Content-Type. The Accept header defines the expected response format when the API returns the response. The Accept header is required for all requests.

Body: The body contains the data that will be submitted as the POST request. When submitting a form, the format data and file content are sent in the body of the request.

The table below provides a description of the Update Invention POST request header and body parameters that are expected by the iEdison API.

Request Parameter	Description	Required	Data Type	Version	In
accept	Specifies the response format that is expected. Set to “application/json”.	Yes	String	v1+	header
inventionRequest	The JSON object that contains attributes used in the request. Refer to the table below for a description of the attributes.	Yes	String	v1+	form-data
inventionDisclosure	The Invention Disclosure document for updating the document in iEdison. The following file types are allowed for the Invention Disclosure document: CSV, GIF, JPEG, JPG, PNG, PDF, DOCX, DOC, TIFF, TIF, TXT, XLS, XLSX, PPT, PPTX, ODT, and RTF. The maximum file size is 50MB.	No	Binary Attachment	v1+	form-data

The table below lists the attributes that will be included in the inventionRequest parameter when updating an invention report. The attributes are included in the JSON object as part of the inventionRequest form-data text element.

JSON Attribute Name	Description	Required	Data Type	Length	Version
inventionReportNumber	Automatically generated by iEdison for an Invention Report after data has been submitted, checked for errors, and verified.	Yes	String	25	v1+
granteeOrganizationName	The name of the organization established at registration. This field is no longer used in the request. The system is using the institutionCode instead. If value is provided, the system will ignore it.	No	String	100	v1+
institutionCode	The unique code is assigned to the reporting organizations.	Yes	String	10	v1+
dunsNumber	The Data Universal Numbering System (DUNS) number provided by Dun & Bradstreet that identifies the grantee/contractor. This field is no longer used in the request. If value is provided for this field, the system will ignore it.	No	String	9	v1+
inventionTitle	The title of the Invention as it appears in the grantee/contractor’s employee’s Invention Report.	Yes	String	255	v1+
inventionDocketNumber	An internal reference number of the grantee/contractor organization to help track a reported Invention(s). If the field is not provide or with value of empty or null, the system will keep the current value in database.	No	String	30	v1+
doesNumber	The DOE S-number is assigned to each DOE Invention. The number is mainly used in DOE’s Invention tracking system. This field is used by Agency client request only. Organization client submit a request with this value will be ignored.	No	String	15	v1+
parentInventionNumber	Invention Report number used when an Invention is combined into another Invention as a parent Invention.	No	String	25	v1+
inventionReportDate	The date that the inventor discloses the subject Invention in writing to the recipient institution. Format: MM/DD/YYYY	Yes	String	10	v1+
firstPublicationDate	The date of first publication, on sale, or public use initiating the one-year statutory period wherein valid Patent protection can still be obtained in the United States. Format: MM/DD/YYYY	No	String	10	v1+
inventionSubmitDate	The date when Invention is submitted to agency. Format: MM/DD/YYYY	No	String	10	v1+
keywords	Any keywords used to identify or categorize your invention.	No	Array [String]	80	v1+
doeWaiver	Refers to the government’s waiver of rights under 10 CFR 784 in an invention arising from DOE-funded research so that private entities may expedite commercialization, quickly bringing their technologies from lab to market. There are three types of waivers: Advance, Identified, and Class patent waivers.	No	String		v1+
institutionCodeForOtherInstitutions	Institution code for other organizations to view Inventions and other related parents. A maximum of three additional iEdison registered organizations may be granted view-only access to an Invention Report.	No	Array [String]		v1+
isExceptionCircumstanceDetermination	Is this invention made under a funding agreement subject to a determination of exceptional circumstances?	No	Boolean		v2+
inventors	List of Inventors	Yes	Array [JSON Object]		v1+
firstName	First name of the inventor.	Yes	String	80	v1+
lastName	Last name of the inventor.	Yes	String	80	v1+
middleInitial	Middle name or first initial of the inventor.	No	String	30	v1+
fedEmployee	Is the inventor a federal employee? true = federal employee, false = not a federal employee (default)	No	Boolean		v1+
fedAgency	If the inventor is a federal employee, the agency the inventor works for. Click here for a list of valid abbreviations.	No	String	80	v1+
primaryAgency	The Primary Agency designated for each Invention Report in iEdison. Click here for a list of valid abbreviations. If organization client provides a new value for this field in the update invention request, the system will ignore it. If current primary agency user provides a new value for this field, the system will update the primary agency.	Yes	String	50	v1+
fundingAgreements	The funding agreement is identified and reported in two parts, the Agency Designation (the acronym for the Federal Agency name) and the grant or contract award number corresponding to the agency that contributed to the Invention.	Yes	Array [JSON Object]		v1+
agency	The federal government agency that made an award that was used to support the conception of the Invention or its first actual reduction to practice. Click here for a list of valid abbreviations.	Yes	String	80	v1+
grantNumber	The corresponding grant or contract number. The format of the grant or contract number is specified by the associated agency.	Yes	String	40	v1+
awardType	Indicates the type of award as a primary award or a sub-award. Refer to Section 12.3 for a list of valid values.	No	String	5	v1+
agreementType	Indicates the type of agreement. Refer to Section 12.1 for a list of valid values.	No	String	80	v1+
subContractInfos	Subcontractor Information		Array [JSON Object]		v1+
subContractNumber	An additional grant or contract number for an Invention or Patent	Yes	String	150	v1+
contractorName	The name of the subcontractor that provided the grant or contract.	No	String	120	v1+
contractorDUNS	The DUNS number of the subcontractor that provided the grant or contract.	No	String	9	v1+
contractorCity	The city of the subcontractor that provided the grant or contract.	No	String	35	v1+
contractorState	The state of the subcontractor that provided the grant or contract. Refer to Section 12.14 for a list of valid Code values.	No	String	2	v1+
contractorCountry	The country of the subcontractor that provided the grant or contract. Refer to Section 12.4 for a list of valid country Name values.	No	String	15	v1+
inventionStatus	Title Election Status	No	JSON Object		v1+
titleElectionStatus	The status of the title to rights in the reported Invention. Refer to Section 12.15 for a list of valid values.	Yes	String	80	v1+
titleElectionDate	The legally binding date that the grantee/contractor elected to retain title to an Invention. This field will be ignored by the system for Organization clients since it is automatically generated when organization clients submit an Invention API request with “Elect to Retain Title Status”. If agency users submit a new date value with an update invention request, the system will update the database with the new value. Format: MM/DD/YYYY	No	String	10	v1+
notElectTitleReason	This field is for the grantee/contractor to select the reason for choosing to Not Elect Title where titleElectionStatus is ‘Does Not Retain Title’ in an Invention Report. Refer to Section 12.7 for a list of valid values. This field will be ignored by the system when titleElectionStatus is not equal to “Does Not Retain Title”.	No	String	255	v1+
notElectTitleOtherReason	If the titleElectionStatus is ‘Does Not Elect Title’ and the notElectTitleReason is ‘Other’, this field is used to provide description of the custom reason for not electing title. This field will be ignored by the system when titleElectionStatus is not equal to “Does Not Retain Title” and notElectTitleReason is not equal to ‘Other’.	No	String	255	v1+
doesNotRetainTitleDate	The date the grantee/contractor chose to Not Elect Title or retain Title in an Invention Report. If organization clients provide a value for this field, the system will ignore the value. If agency user provides a value for this field and the titleElectionStatus is “Does Not Retain Title”, the system will update the database with the new value. Format: MM/DD/YYYY	No	String	10	v1+
dispositionRightsDate	The date the government decided on the disposition of rights. If value is not given when dispositionStatus is selected, the system will use the system date as the value. The API provides this field is for ONLY agency users to update the disposition of rights date. If organization clients provide a value for this field in the update invention request, the system will ignore the value. Format: MM/DD/YYYY	No	String	10	v1+
dispositionStatus	The Invention Disposition status which is the decision of the primary agency as to how to proceed with the technology. Refer to Section 12.6 for a list of valid values. The API provides this field for ONLY the agency clients to update the disposition of rights. If organization clients provide a value for this field in the update invention request, the system will ignore the value.	No	String	255	v2+
explanatoryNotes	Explanatory notes are used to note information about the report.	No	Array [JSON Object]		v1+
note	Explanatory notes are used to note information about an Invention Report or Patent Report. Explanatory notes should not be used for data that is provided by other iEdison data fields.	Yes	String	500	v1+
governmentNotes	Notes written by the agency regarding the report.	No	Array [JSON Object]		v1+
note	Government Notes are used to note information about an Invention Report or Patent Report by federal users who have access to view the record.	Yes	String	500	v1+
budgetIdentifiers	This contains a list of Budget Identifiers for the Invention Report.	No	Array [String]		v1+
agencyCustom1	The agency custom note field. Only available for agency users. If organization client provides a value for this field, the system will ignore it.	No	String	2000	v1+
agencyCustom2	The agency custom note field. Only available for agency users. If organization client provides a value for this field, the system will ignore it.	No	String	2000	v1+
agencyCustom3	The agency custom note field. Only available for agency users. If organization client provides a value for this field, the system will ignore it.	No	String	2000	v1+
governmentStaff	Used to identify government staff. Only available for agency users. If organization client provides a value for this field, the system will ignore it.	No	String	200	v1+
governmentCounsel	Used to identify the Government Counsel (law firm) for an Invention Report. Only available for agency clients. If organization client provides a value for this field, the system will ignore it.	No	String	200	v1+
voidDispositionReason	The reason from the primary agency for voiding the Invention report. The reason will be added to the system as an Explanatory Notes in the Invention report. If organization client provides a value for this field, the system will ignore it.	No	String	500	v2+
govtRetainsRightsReason	The reason from the primary agency for changing Disposition Status to “Government Retains Rights” for the invention when the Title Election Status is “Under Evaluation”, “Elect to Retain Title”, “Government Takes Title (Award Terms)”, or “Designated as Unpatented Biological Material or Research Tool”. The reason will be added to the system as an Explanatory Notes in the Invention report. If organization user provides a value for this field, the system will ignore the value.	No	String	500	v2+

Response Parameters

When the request is processed and the invention report is successfully updated, the Update Invention API endpoint returns an inventionResponse data object. The attributes of this object are described in Section 7.4.

Search Invention, v2

The Search Invention API allows users to specify any combination of the attributes to search for existing Invention Reports. The search will encompass all the Invention Reports from user’s organization and from other organizations that have granted the user permission to view their Invention Reports. Once the user finds the Invention Report, they will be able to modify the Invention, add a Patent Report, or add a Utilization Report. Refer to Appendix A for samples of requests and responses.

Endpoint URI

This is an example of the endpoint for the Search Invention resource.

POST /iedison/api/v2/inventions/search

Request Parameters

The request has the following elements:

Body: The body contains the data that will be submitted as the POST request. When submitting a form, the format data and file content are sent in the body of the request.

The table below provides a description of the Search Invention request header and body parameters that are expected by the iEdison API.

Request Parameter	Description	Data Type	Version	In
accept	Specifies the response format that is expected. Set to “application/json”.	String	v1+	header
inventionSearchCriteria	The JSON object that contains attributes used in the request. Refer to the table below for a description of the attributes.	String	v1+	form-data

The table below lists the attributes that will be included in the inventionSearchCriteria parameter when searching for an Invention Report. The attributes are included in the JSON object as part of the inventionSearchCriteria form-data text element.

Request Parameter	Description	Data Type	Length	Version	In
limit	Total number of records to be retrieved per page. This field must be a number. Max Value = 100, Default = 20	Integer		v1+	body
offset	Page index specified by the user. Default = 0 if user does not provide any offset in the request	Integer		v1+	body
inventionReportNumber	Automatically generated by iEdison for an Invention Report after data has been submitted, checked for errors, and verified.	String	100	v1+	body
inventionDocketNumber	An internal reference number of the grantee/contractor organization to help track a reported Invention(s)	String	30	v1+	body
grantContractNumber	The grant or contract number as specified by the agency. The format is defined by the agency.	String	80	v1+	body
inventorFirstName	The first name of the inventor.	String	50	v1+	body
inventorLastName	The last name of the inventor.	String	50	v1+	body
primaryAgency	The Primary Agency designated for each Invention Report in iEdison. Click here for a list of valid abbreviations.	String	50	v1+	body
granteeOrganizationName	The name of the organization established at registration.	String	100	v1+	body
titleElectionStatus	The status of the title to rights in the reported Invention. Refer to Section 12.15 for a list of valid values.	JSON Object	10	v1+	body
inventionTitle	The title of the Invention as it appears in the grantee/contractors employee’s Invention Report.	String	255	v1+	body
inventionReportDateFrom	The From Date that the inventor disclosed in the subject Invention in writing to the recipient institution. Format: MM/DD/YYYY	String	10	v1+	body
inventionReportDateTo	The To Date that the inventor disclosed in the subject Invention in writing to the recipient institution. Format: MM/DD/YYYY	String	10	v1+	body
inventionKeyword	This field enables the grantee/contractor organization to designate key terms for searching for Invention Reports.	String	80	v1+	body
doeWaiver	DOE Waiver	String		v1+	body
governmentCounsel	Used to identify the Government Counsel (law firm) for an Invention Report.	String		v1+	body
governmentStaff	Used to identify government staff.	String		v1+	body
lastUpdatedFrom	The ‘start from’ search date against the invention last updated date. Will use the last updated date for the invention, but if that is null, then the created date will be used. Format: MM/DD/YYYY	String		v1+	body
lastUpdatedTo	The ‘up to’ search date against the Patent last updated date. Format: MM/DD/YYYY	String		v1+	body

Response Parameters

When the request is processed, the Search Invention API endpoint returns a list of inventions that match the search criteria in the inventionResponse data object. The attributes of this object are described in Section 7.4.

JSON Attribute Name	Description	Data Type	Version
totalRecords	The total number of records for the search.	Number	v1+
limit	The limit entered by the user while making the request i.e., total number of records the user wished to retrieve per page.	Number	v1+
offset	The page index specified by the user.	Number	v1+
inventions	A list of invention records which contains the inventionResponse data object.	Array [JSON Object]	v1+

InventionResponse Data Object

The invention create, update, and search API endpoints share a common InventionResponse data object. The JSON attributes are described in the table below.

JSON Attribute Name	Description	Data Type	Version
inventionReportNumber	Automatically generated by iEdison for an Invention Report after data has been submitted, checked for errors, and verified.	String	v1+
granteeOrganizationName	The name of the organization established at registration.	String	v1+
institutionCode	The unique code assigned to the reporting organizations.	String	v1+
dunsNumber	The Data Universal Numbering System (DUNS) number provided by Dun & Bradstreet that identifies the grantee/contractor.	String	v1+
inventionTitle	The title of the Invention as it appears in the grantee/contractor’s employee’s Invention Report.	String	v1+
inventionDocketNumber	An internal reference number of the grantee/contractor organization to help track a reported Invention(s).	String	v1+
doesNumber	The DOE S-number is assigned to each DOE Invention. The number is mainly used in DOE’s Invention tracking system.	String	v1+
parentInventionNumber	The Invention Report number used when an Invention is combined into another Invention as a parent Invention.	String	v1+
inventionReportDate	The date that the inventor discloses the subject Invention in writing to the recipient institution.	String	v1+
inventionSubmitDate	The date when Invention is submitted to the agency.	String	v1+
reportingOverdue	Indicates if an Invention is submitted outside limit of 60 days or 6 months.	Boolean	v1+
firstPublicationDate	The date of first publication, on sale, or public use initiating the on- year statutory period wherein valid Patent protection can still be obtained in the United States.	String	v1+
domesticManufactureWaiver	Indicates whether a Domestic Manufacture Waiver was requested by the organization.	Boolean	v1+
doeWaiver	DOE Waiver.	String	v1+
institutionCodeForOtherInstitutions	The Institution code for other organizations to view the Invention. A maximum of three additional iEdison registered organizations may be granted view-only access to an Invention Report.	Array [String]	v1+
keywords	Indicates any key terms for searching for Invention Reports.	Array [String]	v1+
isExceptionCircumstanceDetermination	Is this invention made under a funding agreement subject to a determination of exceptional circumstances?	Boolean	v2+
inventors	List of Inventors	Array [JSON Object]	v1+
firstName	First name of the inventor.	String	v1+
lastName	Last name of the inventor.	String	v1+
middleInitial	Middle name or first initial of the inventor.	String	v1+
fedEmployee	Is the inventor a federal employee?	Boolean	v1+
fedAgency	If the inventor is a federal employee, the agency the inventor works for. Click here for a list of valid abbreviations.	String	v1+
id	The unique identifier assigned to the inventor.	Integer	v2+
primaryAgency	The Primary Agency designated for each Invention Report in iEdison. Click here for a list of valid abbreviations.	String	v1+
fundingAgreements	The funding agreement is identified and reported in two parts, the Agency Designation (the acronym for the Federal Agency name) and the grant or contract award number corresponding to the agency that contributed to the Invention.	Array [JSON Object]	v1+
agency	The federal government agency that made an award that was used to support the conception of the Invention or its first actual reduction to practice. Click here for a list of valid abbreviations.	String	v1+
grantNumber	The corresponding grant or contract number. The format of the grant or contract number is specified by the associated agency.	String	v1+
awardType	Indicates the type of award as a primary award or sub-award. Refer to Section 12.3 for a list of valid values.	String	v1+
agreementType	Indicates the type of agreement. Refer to Section 12.1 for a list of valid values.	String	v1+
id	The funding agreement primary unique identifier in the iEdison system.	Integer	v2+
subContractInfos	Subcontractor Information	Array [JSON Object]	v1+
subContractNumber	An additional grant or contract number for an Invention or Patent.	String	v1+
contractorName	The name of the subcontractor that provided the grant or contract.	String	v1+
contractorDUNS	The DUNS number of the subcontractor that provided the grant or contract.	String	v1+
contractorCity	The city of the subcontractor that provided the grant or contract.	String	v1+
contractorState	The state of the subcontractor that provided the grant or contract. Refer to Section 12.14 for a list of valid values.	String	v1+
contractorCountry	The country of the subcontractor that provided the grant or contract. Refer to Section 12.4 for a list of valid values.	String	v1+
id	The subcontractor primary unique identifier in the iEdison system.	Integer	v2+
inventionStatus	Title Election Status and Disposition Status	JSON Object	v1+
titleElectionStatus	The status of the title to rights in the reported Invention. Refer to Section 12.15 for a list of valid values.	String	v1+
titleElectionDate	The legally binding date that the grantee/contractor elected to retain title to an Invention.	String	v1+
notElectTitleReason	This field is for the grantee/contractor to select the reason for choosing Does Not Retain Title in an Invention Report. Refer to Section 12.7 for a list of valid values.	String	v1+
notElectTitleOtherReason	If the titleElectionStatus is ‘Does Not Retain Title’ and notElectTitleReason is ‘Other’, this field is used to provide the description of the custom reason for not electing title.	String	v1+
dispositionStatus	The government’s decision/outcome of the disposition of rights. Refer to Section 12.6 for a list of valid values.	String	v1+
dispositionRightsDate	The date the government decided on the disposition of rights.	String	v1+
doesNotRetainTitleDate	The date the grantee/contractor chose to Not Elect Title or retain Title in an Invention Report.	String	v1+
explanatoryNotes	Explanatory Notes	Array [JSON Object]	v1+
note	Explanatory notes or additional information about an Invention Report or Patent Report. Explanatory notes should not be used for data that is provided by other iEdison data fields.	String	v1+
creatorName	The full name of the user who entered the explanatory note.	String	v1+
createdDate	The date when the user entered the explanatory note.	String	v1+
id	The unique identifier assigned to the explanatory note.	Integer	v2+
governmentNotes	Government Notes which only return for agency system users. This field and value will display to agency users only.	Array [JSON Object]	v1+
note	Government Notes are information about an Invention Report or Patent Report by federal agency users who have access to view the record.	String	v1+
creatorName	The full name of the user who entered the government note.	String	v1+
createdDate	The date when the user entered the government note.	String	v1+
id	The unique identifier assigned to the government note.	Integer	v2+
budgetIdentifiers	This contains a list of Budget Identifiers for the Invention report.	Array [String]	v1+
agencyCustom1	The agency custom note field. Only available for agency users. This field will not show in the responses to the organization system susers.	String	v1+
agencyCustom2	The agency custom note field. Only available for agency users. This field will not show in the responses to the organization system susers.	String	v1+
agencyCustom3	The agency custom note field. Only available for agency users. This field will not show in the responses to the organization system susers.	String	v1+
governmentStaff	Used to identify government staff. This field and value will display to agency users only. This field will not show in the responses to the organization system susers.	String	v1+
governmentCounsel	Used to identify the Government Counsel (law firm) for an Invention Report. This field and value will display to agency users only. This field will not show in the responses to the organization system susers.	String	v1+
disclosureDocumentAcceptDate	The date the Disclosure document was accepted.	Date	v1+
disclosureDocumentRejectDate	The date the Disclosure document was rejected.	Date	v1+
disclosureDocumentRejectReasons	The reason the Disclosure document was rejected.	Array [String]	v1+
createdDate	The date the Invention Report was created in the iEdison system.	String	v1+
lastUpdatedDate	The date the invention Report was last updated in the iEdison system.	String	v1+
id	The unique identifier assigned to the Invention Report in the iEdison system.	Integer	v2+