API Documentation
Kuali Research REST APIs - Institutional Proposal
Research Institutional Proposal ¶
Institutional Proposal Document ¶
Insert Institutional Proposal DocumentPOST/instprop/api/v1/institutional-proposal-document/
Example URI
POST /instprop/api/v1/institutional-proposal-document/
URI Parameters
- createProposalLog
boolean(optional)Flag to determine whether to create and associate a Proposal Log. If not present, defaults false.
- route
boolean(optional)Flag to determine if it will automatically submit the created maintenance document into routing. If not present, defaults false.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalId": "(val)",
"proposalNumber": "(val)",
"sponsorProposalNumber": "(val)",
"sequenceNumber": "(val)",
"proposalTypeCode": "(val)",
"currentAccountNumber": "(val)",
"title": "(val)",
"sponsorCode": "(val)",
"rolodexId": "(val)",
"noticeOfOpportunityCode": "(val)",
"gradStudHeadcount": "(val)",
"gradStudPersonMonths": null,
"typeOfAccount": "(val)",
"activityTypeCode": "(val)",
"requestedStartDateInitial": "(val)",
"requestedStartDateTotal": "(val)",
"requestedEndDateInitial": "(val)",
"requestedEndDateTotal": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"totalDirectCostInitial": "(val)",
"totalDirectCostTotal": "(val)",
"totalIndirectCostInitial": "(val)",
"totalIndirectCostTotal": "(val)",
"numberOfCopies": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"createTimestamp": "(val)",
"deadlineType": "(val)",
"mailBy": "(val)",
"mailType": "(val)",
"mailAccountNumber": "(val)",
"mailDescription": "(val)",
"subcontractFlag": "(val)",
"costSharingIndicator": "(val)",
"idcRateIndicator": "(val)",
"specialReviewIndicator": "(val)",
"statusCode": "(val)",
"unitNumber": "(val)",
"scienceCodeIndicator": "(val)",
"nsfSequenceNumber": "(val)",
"primeSponsorCode": "(val)",
"primeSponsor": "(val)",
"initialContractAdmin": "(val)",
"ipReviewActivityIndicator": "(val)",
"currentAwardNumber": "(val)",
"cfdaNumber": "(val)",
"opportunity": "(val)",
"awardTypeCode": "(val)",
"newDescription": "(val)",
"proposalSequenceStatus": "(val)",
"instProposalNumber": "(val)",
"docNbr": "(val)",
"docStatus": "(val)",
"documentDescription": "(val)",
"persons": [
{
"personId": "(val)",
"roleCode": "(val)",
"keyPersonRole": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"faculty": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"institutionalProposalContactId": "(val)",
"creditSplits": [
{
"institutionalProposalPersonCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
],
"units": [
{
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"creditSplits": [
{
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
]
}
]
}
],
"customData": [
{
"customAttributeId": "(val)",
"value": "(val)"
}
],
"specialReviews": [
{
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"protocolNumber": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"expirationDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)"
}
],
"ipCostShares": [
{
"proposalCostShareId": "(val)",
"projectPeriod": "(val)",
"costSharePercentage": "(val)",
"costShareTypeCode": "(val)",
"sourceAccount": "(val)",
"amount": "(val)",
"unitNumber": "(val)"
}
],
"ipComments": [
{
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)"
}
],
"IpUnrecoveredFandAs": [
{
"proposalUnrecoveredFandAId": "(val)",
"applicableIndirectcostRate": "(val)",
"indirectcostRateTypeCode": "(val)",
"fiscalYear": "(val)",
"onCampusFlag": "(val)",
"underrecoveryOfIndirectcost": "(val)",
"sourceAccount": "(val)"
}
],
"ipFandAs": [
{
"proposalId": "(val)",
"proposalFandARateId": "(val)",
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"instituteRate": "(val)",
"applicableRate": "(val)",
"activityTypeCode": "(val)",
"amount": "(val)"
}
],
"proposalCfdas": [
{
"cfdaNumber": "(val)",
"cfdaDescription": "(val)"
}
],Response
201Headers
Content-Type: application/json;charset=UTF-8Body
(Document Number)Delete Institutional Proposal Document by Document NumberDELETE/instprop/api/v1/institutional-proposal-document/(documentNumber)
Example URI
DELETE /instprop/api/v1/institutional-proposal-document/(documentNumber)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Get Institutional Proposal Document by Document NumberGET/instprop/api/v1/institutional-proposal-document/(documentNumber)
Example URI
GET /instprop/api/v1/institutional-proposal-document/(documentNumber)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"proposalId": "(val)",
"proposalNumber": "(val)",
"sponsorProposalNumber": "(val)",
"sequenceNumber": "(val)",
"proposalTypeCode": "(val)",
"currentAccountNumber": "(val)",
"title": "(val)",
"sponsorCode": "(val)",
"sponsor": {
"sponsorCode": "(val)",
"sponsorName": "(val)",
"acronym": "(val)",
"nih": "(val)",
"kcoiPhs": "(val)",
"sponsorType": {
"code": "(val)",
"description": "(val)"
}
},
"rolodexId": "(val)",
"noticeOfOpportunityCode": "(val)",
"gradStudHeadcount": "(val)",
"gradStudPersonMonths": "(val)",
"typeOfAccount": "(val)",
"activityTypeCode": "(val)",
"requestedStartDateInitial": "(val)",
"requestedStartDateTotal": "(val)",
"requestedEndDateInitial": "(val)",
"requestedEndDateTotal": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"totalDirectCostInitial": "(val)",
"totalDirectCostTotal": "(val)",
"totalIndirectCostInitial": "(val)",
"totalIndirectCostTotal": "(val)",
"numberOfCopies": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"createTimestamp": "(val)",
"deadlineType": "(val)",
"mailBy": "(val)",
"mailType": "(val)",
"mailAccountNumber": "(val)",
"mailDescription": "(val)",
"subcontractFlag": "(val)",
"costSharingIndicator": "(val)",
"idcRateIndicator": "(val)",
"specialReviewIndicator": "(val)",
"statusCode": "(val)",
"unitNumber": "(val)",
"scienceCodeIndicator": "(val)",
"nsfSequenceNumber": "(val)",
"primeSponsorCode": "(val)",
"primeSponsor": "(val)",
"initialContractAdmin": "(val)",
"ipReviewActivityIndicator": "(val)",
"currentAwardNumber": "(val)",
"cfdaNumber": "(val)",
"opportunity": "(val)",
"awardTypeCode": "(val)",
"newDescription": "(val)",
"proposalSequenceStatus": "(val)",
"instProposalNumber": "(val)",
"docNbr": "(val)",
"docStatus": "(val)",
"documentDescription": "(val)",
"persons": [
{
"personId": "(val)",
"roleCode": "(val)",
"keyPersonRole": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"faculty": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"institutionalProposalContactId": "(val)",
"creditSplits": [
{
"institutionalProposalPersonCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
],
"units": [
{
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"unit": {
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"organization": {
"organizationId": "(val)",
"organizationName": "(val)",
"address": "(val)",
"federalEmployerId": "(val)",
"dunsNumber": "(val)",
"uei": "(val)",
"contact": {
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"sponsor": {
"sponsorCode": "(val)",
"sponsorName": "(val)",
"acronym": "(val)",
"nih": "(val)",
"kcoiPhs": "(val)",
"sponsorType": {
"code": "(val)",
"description": "(val)"
}
},
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)"
},
"organizationTypes": [
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"organizationTypeList": {
"code": "(val)",
"description": "(val)"
}
}
]
}
},
"creditSplits": [
{
"institutionalProposalPersonCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
]
}
]
}
],
"customData": [
{
"customAttributeId": "(val)",
"value": "(val)"
}
],
"specialReviews": [
{
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"protocolNumber": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"expirationDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)"
}
],
"ipCostShares": [
{
"proposalCostShareId": "(val)",
"projectPeriod": "(val)",
"costSharePercentage": "(val)",
"costShareTypeCode": "(val)",
"sourceAccount": "(val)",
"amount": "(val)",
"unitNumber": "(val)"
}
],
"ipComments": [
{
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)"
}
],
"IpUnrecoveredFandAs": [
{
"proposalUnrecoveredFandAId": "(val)",
"applicableIndirectcostRate": "(val)",
"indirectcostRateTypeCode": "(val)",
"fiscalYear": "(val)",
"onCampusFlag": "(val)",
"underrecoveryOfIndirectcost": "(val)",
"sourceAccount": "(val)"
}
],
"ipFandAs": [
{
"proposalId": "(val)",
"proposalFandARateId": "(val)",
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"instituteRate": "(val)",
"applicableRate": "(val)",
"activityTypeCode": "(val)",
"amount": "(val)"
}
],
"proposalCfdas": [
{
"cfdaNumber": "(val)",
"cfdaDescription": "(val)"
}
],Insert Institutional Proposal PersonPOST/instprop/api/v1/institutional-proposal-document/(documentNumber)/proposal-persons
Example URI
POST /instprop/api/v1/institutional-proposal-document/(documentNumber)/proposal-persons
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personId": "(val)",
"roleCode": "(val)",
"keyPersonRole": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"faculty": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"institutionalProposalContactId": "(val)",
"creditSplits": [
{
"institutionalProposalPersonCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
],
"units": [
{
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"creditSplits": [
{
"institutionalProposalPersonCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
]
}
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personId": "(val)",
"roleCode": "(val)",
"keyPersonRole": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"faculty": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"institutionalProposalContactId": "(val)",
"creditSplits": [
{
"institutionalProposalPersonCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
],
"units": [
{
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"unit": {
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"organization": {
"organizationId": "(val)",
"organizationName": "(val)",
"address": "(val)",
"federalEmployerId": "(val)",
"dunsNumber": "(val)",
"uei": "(val)",
"contact": {
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"sponsor": {
"sponsorCode": "(val)",
"sponsorName": "(val)",
"acronym": "(val)",
"nih": "(val)",
"kcoiPhs": "(val)",
"sponsorType": {
"code": "(val)",
"description": "(val)"
}
},
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)"
},
"organizationTypes": [
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"organizationTypeList": {
"code": "(val)",
"description": "(val)"
}
}
]
}
},
"creditSplits": [
{
"institutionalProposalPersonCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
]
}
]
}
]Get All Institutional Proposal Persons from Document NumberGET/instprop/api/v1/institutional-proposal-document/(documentNumber)/proposal-persons
Example URI
GET /instprop/api/v1/institutional-proposal-document/(documentNumber)/proposal-persons
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personId": "(val)",
"roleCode": "(val)",
"keyPersonRole": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"faculty": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"institutionalProposalContactId": "(val)",
"creditSplits": [
{
"institutionalProposalPersonCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
],
"units": [
{
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"unit": {
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"organization": {
"organizationId": "(val)",
"organizationName": "(val)",
"address": "(val)",
"federalEmployerId": "(val)",
"dunsNumber": "(val)",
"uei": "(val)",
"contact": {
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"sponsor": {
"sponsorCode": "(val)",
"sponsorName": "(val)",
"acronym": "(val)",
"nih": "(val)",
"kcoiPhs": "(val)",
"sponsorType": {
"code": "(val)",
"description": "(val)"
}
},
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)"
},
"organizationTypes": [
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"organizationTypeList": {
"code": "(val)",
"description": "(val)"
}
}
]
}
},
"creditSplits": [
{
"institutionalProposalPersonCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
]
}
]
}
]Delete Institutional Proposal PersonDELETE/instprop/api/v1/institutional-proposal-document/(documentNumber)/proposal-persons/(id)
Example URI
DELETE /instprop/api/v1/institutional-proposal-document/(documentNumber)/proposal-persons/(id)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Get Institutional Proposal Person from Document NumberGET/instprop/api/v1/institutional-proposal-document/(documentNumber)/proposal-persons/(id)
Example URI
GET /instprop/api/v1/institutional-proposal-document/(documentNumber)/proposal-persons/(id)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personId": "(val)",
"roleCode": "(val)",
"keyPersonRole": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"faculty": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"institutionalProposalContactId": "(val)",
"creditSplits": [
{
"institutionalProposalPersonCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
],
"units": [
{
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"unit": {
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"organization": {
"organizationId": "(val)",
"organizationName": "(val)",
"address": "(val)",
"federalEmployerId": "(val)",
"dunsNumber": "(val)",
"uei": "(val)",
"contact": {
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"sponsor": {
"sponsorCode": "(val)",
"sponsorName": "(val)",
"acronym": "(val)",
"nih": "(val)",
"kcoiPhs": "(val)",
"sponsorType": {
"code": "(val)",
"description": "(val)"
}
},
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)"
},
"organizationTypes": [
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"organizationTypeList": {
"code": "(val)",
"description": "(val)"
}
}
]
}
},
"creditSplits": [
{
"institutionalProposalPersonCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
]
}
]
}Route Institutional Proposal DocumentPUT/instprop/api/v1/institutional-proposal-document/(documentNumber)
Example URI
PUT /instprop/api/v1/institutional-proposal-document/(documentNumber)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Get Institutional Proposal Documents by CriteriaGET/instprop/api/v2/institutional-proposals
Example URI
GET /instprop/api/v2/institutional-proposals
URI Parameters
- ipNumber
string(optional)The Institutional Proposal Number.
- activeVersionOnly
boolean(optional)Flag to determine if it will only get the active version of the Institutional Proposal. If not present, defaults false.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalId": "(val)",
"proposalNumber": "(val)",
"sponsorProposalNumber": "(val)",
"sequenceNumber": "(val)",
"proposalTypeCode": "(val)",
"currentAccountNumber": "(val)",
"title": "(val)",
"sponsorCode": "(val)",
"sponsor": {
"sponsorCode": "(val)",
"sponsorName": "(val)",
"acronym": "(val)",
"nih": "(val)",
"kcoiPhs": "(val)",
"sponsorType": {
"code": "(val)",
"description": "(val)"
}
},
"rolodexId": "(val)",
"noticeOfOpportunityCode": "(val)",
"gradStudHeadcount": "(val)",
"gradStudPersonMonths": "(val)",
"typeOfAccount": "(val)",
"activityTypeCode": "(val)",
"requestedStartDateInitial": "(val)",
"requestedStartDateTotal": "(val)",
"requestedEndDateInitial": "(val)",
"requestedEndDateTotal": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"totalDirectCostInitial": "(val)",
"totalDirectCostTotal": "(val)",
"totalIndirectCostInitial": "(val)",
"totalIndirectCostTotal": "(val)",
"numberOfCopies": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"createTimestamp": "(val)",
"deadlineType": "(val)",
"mailBy": "(val)",
"mailType": "(val)",
"mailAccountNumber": "(val)",
"mailDescription": "(val)",
"subcontractFlag": "(val)",
"costSharingIndicator": "(val)",
"idcRateIndicator": "(val)",
"specialReviewIndicator": "(val)",
"statusCode": "(val)",
"unitNumber": "(val)",
"scienceCodeIndicator": "(val)",
"nsfSequenceNumber": "(val)",
"primeSponsorCode": "(val)",
"primeSponsor": "(val)",
"initialContractAdmin": "(val)",
"ipReviewActivityIndicator": "(val)",
"currentAwardNumber": "(val)",
"cfdaNumber": "(val)",
"opportunity": "(val)",
"awardTypeCode": "(val)",
"newDescription": "(val)",
"proposalSequenceStatus": "(val)",
"instProposalNumber": "(val)",
"docNbr": "(val)",
"docStatus": "(val)",
"documentDescription": "(val)",
"persons": [
{
"personId": "(val)",
"roleCode": "(val)",
"keyPersonRole": "(val)",
"rolodexId": "(val)",
"fullName": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"faculty": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"institutionalProposalContactId": "(val)",
"creditSplits": [
{
"institutionalProposalPersonCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
],
"units": [
{
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"unit": {
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"organization": {
"organizationId": "(val)",
"organizationName": "(val)",
"address": "(val)",
"federalEmployerId": "(val)",
"dunsNumber": "(val)",
"uei": "(val)",
"contact": {
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"sponsor": {
"sponsorCode": "(val)",
"sponsorName": "(val)",
"acronym": "(val)",
"nih": "(val)",
"kcoiPhs": "(val)",
"sponsorType": {
"code": "(val)",
"description": "(val)"
}
},
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)"
},
"organizationTypes": [
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"organizationTypeList": {
"code": "(val)",
"description": "(val)"
}
}
]
}
},
"creditSplits": [
{
"institutionalProposalPersonCreditSplitId": "(val)",
"credit": "(val)",
"investigatorCreditType": {
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)"
}
}
]
}
]
}
],
"customData": [
{
"customAttributeId": "(val)",
"value": "(val)"
}
],
"specialReviews": [
{
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"protocolNumber": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"expirationDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)"
}
],
"ipCostShares": [
{
"proposalCostShareId": "(val)",
"projectPeriod": "(val)",
"costSharePercentage": "(val)",
"costShareTypeCode": "(val)",
"sourceAccount": "(val)",
"amount": "(val)",
"unitNumber": "(val)"
}
],
"ipComments": [
{
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"commentTypeCode": "(val)",
"comments": "(val)"
}
],
"IpUnrecoveredFandAs": [
{
"proposalUnrecoveredFandAId": "(val)",
"applicableIndirectcostRate": "(val)",
"indirectcostRateTypeCode": "(val)",
"fiscalYear": "(val)",
"onCampusFlag": "(val)",
"underrecoveryOfIndirectcost": "(val)",
"sourceAccount": "(val)"
}
],
"ipFandAs": [
{
"proposalId": "(val)",
"proposalFandARateId": "(val)",
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"instituteRate": "(val)",
"applicableRate": "(val)",
"activityTypeCode": "(val)",
"amount": "(val)"
}
],
"proposalCfdas": [
{
"cfdaNumber": "(val)",
"cfdaDescription": "(val)"
}
],Indirectcost Rate Types ¶
Get Indirectcost Rate Types by KeyGET/instprop/api/v1/indirectcost-rate-types/(key)
Example URI
GET /instprop/api/v1/indirectcost-rate-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Indirectcost Rate TypesGET/instprop/api/v1/indirectcost-rate-types/
Example URI
GET /instprop/api/v1/indirectcost-rate-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Indirectcost Rate Types with FilteringGET/instprop/api/v1/indirectcost-rate-types/
Example URI
GET /instprop/api/v1/indirectcost-rate-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- indirectcostRateTypeCode
string(optional)Indirectcost Rate Type Code. Maximum length is 22. Validating pattern is ^[0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Indirectcost Rate TypesGET/instprop/api/v1/indirectcost-rate-types/
Example URI
GET /instprop/api/v1/indirectcost-rate-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"description",
"indirectcostRateTypeCode"
],
"primaryKey": "indirectcostRateTypeCode"
}Get Blueprint API specification for Indirectcost Rate TypesGET/instprop/api/v1/indirectcost-rate-types/
Example URI
GET /instprop/api/v1/indirectcost-rate-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Indirectcost Rate Types.md"
transfer-encoding: chunkedUpdate Indirectcost Rate TypesPUT/instprop/api/v1/indirectcost-rate-types/(key)
Example URI
PUT /instprop/api/v1/indirectcost-rate-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Indirectcost Rate TypesPUT/instprop/api/v1/indirectcost-rate-types/
Example URI
PUT /instprop/api/v1/indirectcost-rate-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Indirectcost Rate TypesPATCH/instprop/api/v1/indirectcost-rate-types/(key)
Example URI
PATCH /instprop/api/v1/indirectcost-rate-types/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Indirectcost Rate TypesPOST/instprop/api/v1/indirectcost-rate-types/
Example URI
POST /instprop/api/v1/indirectcost-rate-types/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Indirectcost Rate TypesPOST/instprop/api/v1/indirectcost-rate-types/
Example URI
POST /instprop/api/v1/indirectcost-rate-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"indirectcostRateTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Indirectcost Rate Types by KeyDELETE/instprop/api/v1/indirectcost-rate-types/(key)
Example URI
DELETE /instprop/api/v1/indirectcost-rate-types/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Indirectcost Rate TypesDELETE/instprop/api/v1/indirectcost-rate-types/
Example URI
DELETE /instprop/api/v1/indirectcost-rate-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Indirectcost Rate Types with MatchingDELETE/instprop/api/v1/indirectcost-rate-types/
Example URI
DELETE /instprop/api/v1/indirectcost-rate-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- indirectcostRateTypeCode
string(optional)Indirectcost Rate Type Code. Maximum length is 22. Validating pattern is ^[0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalInstitutional Proposal Attachment Types ¶
Get Institutional Proposal Attachment Types by KeyGET/instprop/api/v1/institutional-proposal-attachment-types/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-attachment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal Attachment TypesGET/instprop/api/v1/institutional-proposal-attachment-types/
Example URI
GET /instprop/api/v1/institutional-proposal-attachment-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Attachment Types with FilteringGET/instprop/api/v1/institutional-proposal-attachment-types/
Example URI
GET /instprop/api/v1/institutional-proposal-attachment-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- allowMultiple
string(optional)allowMultiple. Maximum length is 1. Validating pattern is ^[\p{Graph}]*$.
- attachmentTypeCode
string(optional)Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\u0000-\uFFFF]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal Attachment TypesGET/instprop/api/v1/institutional-proposal-attachment-types/
Example URI
GET /instprop/api/v1/institutional-proposal-attachment-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"allowMultiple",
"attachmentTypeCode",
"description"
],
"primaryKey": "attachmentTypeCode"
}Get Blueprint API specification for Institutional Proposal Attachment TypesGET/instprop/api/v1/institutional-proposal-attachment-types/
Example URI
GET /instprop/api/v1/institutional-proposal-attachment-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Attachment Types.md"
transfer-encoding: chunkedUpdate Institutional Proposal Attachment TypesPUT/instprop/api/v1/institutional-proposal-attachment-types/(key)
Example URI
PUT /instprop/api/v1/institutional-proposal-attachment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Institutional Proposal Attachment TypesPUT/instprop/api/v1/institutional-proposal-attachment-types/
Example URI
PUT /instprop/api/v1/institutional-proposal-attachment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Institutional Proposal Attachment TypesPATCH/instprop/api/v1/institutional-proposal-attachment-types/(key)
Example URI
PATCH /instprop/api/v1/institutional-proposal-attachment-types/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Institutional Proposal Attachment TypesPOST/instprop/api/v1/institutional-proposal-attachment-types/
Example URI
POST /instprop/api/v1/institutional-proposal-attachment-types/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Institutional Proposal Attachment TypesPOST/instprop/api/v1/institutional-proposal-attachment-types/
Example URI
POST /instprop/api/v1/institutional-proposal-attachment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"allowMultiple": "(val)",
"attachmentTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Institutional Proposal Attachment Types by KeyDELETE/instprop/api/v1/institutional-proposal-attachment-types/(key)
Example URI
DELETE /instprop/api/v1/institutional-proposal-attachment-types/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Institutional Proposal Attachment TypesDELETE/instprop/api/v1/institutional-proposal-attachment-types/
Example URI
DELETE /instprop/api/v1/institutional-proposal-attachment-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Institutional Proposal Attachment Types with MatchingDELETE/instprop/api/v1/institutional-proposal-attachment-types/
Example URI
DELETE /instprop/api/v1/institutional-proposal-attachment-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- allowMultiple
string(optional)allowMultiple. Maximum length is 1. Validating pattern is ^[\p{Graph}]*$.
- attachmentTypeCode
string(optional)Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\u0000-\uFFFF]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalInstitutional Proposal Attachments ¶
Get Institutional Proposal Attachments by KeyGET/instprop/api/v1/institutional-proposal-attachments/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal AttachmentsGET/instprop/api/v1/institutional-proposal-attachments/
Example URI
GET /instprop/api/v1/institutional-proposal-attachments/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Attachments with FilteringGET/instprop/api/v1/institutional-proposal-attachments/
Example URI
GET /instprop/api/v1/institutional-proposal-attachments/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- attachmentNumber
string(optional)- attachmentTitle
string(optional)Description. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- attachmentTypeCode
string(optional)Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
- comments
string(optional)Comments. Maximum length is 2000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- contentType
string(optional)- documentStatusCode
string(optional)- fileDataId
string(optional)- fileName
string(optional)Id. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- lastUpdateTimestamp
string(optional)The creation or last modification timestamp. Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- lastUpdateUser
string(optional)The user who created or last modified the object. Maximum length is 60. Validating pattern is ^[\p{Graph}]*$.
- proposalAttachmentId
string(optional)- proposalId
string(optional)- proposalNumber
string(optional)- sequenceNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal AttachmentsGET/instprop/api/v1/institutional-proposal-attachments/
Example URI
GET /instprop/api/v1/institutional-proposal-attachments/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"attachmentNumber",
"attachmentTitle",
"attachmentTypeCode",
"comments",
"contentType",
"documentStatusCode",
"fileDataId",
"fileName",
"lastUpdateTimestamp",
"lastUpdateUser",
"proposalAttachmentId",
"proposalId",
"proposalNumber",
"sequenceNumber"
],
"primaryKey": "proposalAttachmentId"
}Get Blueprint API specification for Institutional Proposal AttachmentsGET/instprop/api/v1/institutional-proposal-attachments/
Example URI
GET /instprop/api/v1/institutional-proposal-attachments/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Attachments.md"
transfer-encoding: chunkedUpdate Institutional Proposal AttachmentsPUT/instprop/api/v1/institutional-proposal-attachments/(key)
Example URI
PUT /instprop/api/v1/institutional-proposal-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Institutional Proposal AttachmentsPUT/instprop/api/v1/institutional-proposal-attachments/
Example URI
PUT /instprop/api/v1/institutional-proposal-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Institutional Proposal AttachmentsPATCH/instprop/api/v1/institutional-proposal-attachments/(key)
Example URI
PATCH /instprop/api/v1/institutional-proposal-attachments/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Institutional Proposal AttachmentsPOST/instprop/api/v1/institutional-proposal-attachments/
Example URI
POST /instprop/api/v1/institutional-proposal-attachments/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Institutional Proposal AttachmentsPOST/instprop/api/v1/institutional-proposal-attachments/
Example URI
POST /instprop/api/v1/institutional-proposal-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentNumber": "(val)",
"attachmentTitle": "(val)",
"attachmentTypeCode": "(val)",
"comments": "(val)",
"contentType": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"proposalAttachmentId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Institutional Proposal Attachments by KeyDELETE/instprop/api/v1/institutional-proposal-attachments/(key)
Example URI
DELETE /instprop/api/v1/institutional-proposal-attachments/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Institutional Proposal AttachmentsDELETE/instprop/api/v1/institutional-proposal-attachments/
Example URI
DELETE /instprop/api/v1/institutional-proposal-attachments/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Institutional Proposal Attachments with MatchingDELETE/instprop/api/v1/institutional-proposal-attachments/
Example URI
DELETE /instprop/api/v1/institutional-proposal-attachments/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- attachmentNumber
string(optional)- attachmentTitle
string(optional)Description. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- attachmentTypeCode
string(optional)Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
- comments
string(optional)Comments. Maximum length is 2000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- contentType
string(optional)- documentStatusCode
string(optional)- fileDataId
string(optional)- fileName
string(optional)Id. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- lastUpdateTimestamp
string(optional)The creation or last modification timestamp. Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- lastUpdateUser
string(optional)The user who created or last modified the object. Maximum length is 60. Validating pattern is ^[\p{Graph}]*$.
- proposalAttachmentId
string(optional)- proposalId
string(optional)- proposalNumber
string(optional)- sequenceNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalInstitutional Proposal Comments ¶
Get Institutional Proposal Comments by KeyGET/instprop/api/v1/institutional-proposal-comments/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-comments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal CommentsGET/instprop/api/v1/institutional-proposal-comments/
Example URI
GET /instprop/api/v1/institutional-proposal-comments/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Comments with FilteringGET/instprop/api/v1/institutional-proposal-comments/
Example URI
GET /instprop/api/v1/institutional-proposal-comments/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- commentTypeCode
string(optional)Comment Type Code. Maximum length is 22. Validating pattern is ^[A-Za-z0-9-]*$.
- comments
string(optional)Comments. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- proposalCommentsId
string(optional)Proposal Comments Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- proposalId
string(optional)Proposal Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal CommentsGET/instprop/api/v1/institutional-proposal-comments/
Example URI
GET /instprop/api/v1/institutional-proposal-comments/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"commentTypeCode",
"comments",
"proposalCommentsId",
"proposalId",
"proposalNumber",
"sequenceNumber"
],
"primaryKey": "proposalCommentsId"
}Get Blueprint API specification for Institutional Proposal CommentsGET/instprop/api/v1/institutional-proposal-comments/
Example URI
GET /instprop/api/v1/institutional-proposal-comments/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Comments.md"
transfer-encoding: chunkedUpdate Institutional Proposal CommentsPUT/instprop/api/v1/institutional-proposal-comments/(key)
Example URI
PUT /instprop/api/v1/institutional-proposal-comments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Institutional Proposal CommentsPUT/instprop/api/v1/institutional-proposal-comments/
Example URI
PUT /instprop/api/v1/institutional-proposal-comments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Institutional Proposal CommentsPATCH/instprop/api/v1/institutional-proposal-comments/(key)
Example URI
PATCH /instprop/api/v1/institutional-proposal-comments/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Institutional Proposal CommentsPOST/instprop/api/v1/institutional-proposal-comments/
Example URI
POST /instprop/api/v1/institutional-proposal-comments/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Institutional Proposal CommentsPOST/instprop/api/v1/institutional-proposal-comments/
Example URI
POST /instprop/api/v1/institutional-proposal-comments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Institutional Proposal Comments by KeyDELETE/instprop/api/v1/institutional-proposal-comments/(key)
Example URI
DELETE /instprop/api/v1/institutional-proposal-comments/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Institutional Proposal CommentsDELETE/instprop/api/v1/institutional-proposal-comments/
Example URI
DELETE /instprop/api/v1/institutional-proposal-comments/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Institutional Proposal Comments with MatchingDELETE/instprop/api/v1/institutional-proposal-comments/
Example URI
DELETE /instprop/api/v1/institutional-proposal-comments/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- commentTypeCode
string(optional)Comment Type Code. Maximum length is 22. Validating pattern is ^[A-Za-z0-9-]*$.
- comments
string(optional)Comments. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- proposalCommentsId
string(optional)Proposal Comments Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- proposalId
string(optional)Proposal Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalInstitutional Proposal Custom Data ¶
Get Institutional Proposal Custom Data by KeyGET/instprop/api/v1/institutional-proposal-custom-data/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-custom-data/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal Custom DataGET/instprop/api/v1/institutional-proposal-custom-data/
Example URI
GET /instprop/api/v1/institutional-proposal-custom-data/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Custom Data with FilteringGET/instprop/api/v1/institutional-proposal-custom-data/
Example URI
GET /instprop/api/v1/institutional-proposal-custom-data/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- institutionalProposal.proposalId
string(optional)- customAttributeId
string(optional)Custom Attribute Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- proposalCustomDataId
string(optional)Proposal Custom Data Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- proposalNumber
string(optional)Proposal Number. Maximum length is 10. Validating pattern is ^[A-Za-z0-9]*$.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.
- value
string(optional)Value. Maximum length is 2000. Validating pattern is ^[\u0000-\uFFFF]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal Custom DataGET/instprop/api/v1/institutional-proposal-custom-data/
Example URI
GET /instprop/api/v1/institutional-proposal-custom-data/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"institutionalProposal.proposalId",
"customAttributeId",
"proposalCustomDataId",
"proposalNumber",
"sequenceNumber",
"value"
],
"primaryKey": "proposalCustomDataId"
}Get Blueprint API specification for Institutional Proposal Custom DataGET/instprop/api/v1/institutional-proposal-custom-data/
Example URI
GET /instprop/api/v1/institutional-proposal-custom-data/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Custom Data.md"
transfer-encoding: chunkedUpdate Institutional Proposal Custom DataPUT/instprop/api/v1/institutional-proposal-custom-data/(key)
Example URI
PUT /instprop/api/v1/institutional-proposal-custom-data/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Institutional Proposal Custom DataPUT/instprop/api/v1/institutional-proposal-custom-data/
Example URI
PUT /instprop/api/v1/institutional-proposal-custom-data/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Institutional Proposal Custom DataPATCH/instprop/api/v1/institutional-proposal-custom-data/(key)
Example URI
PATCH /instprop/api/v1/institutional-proposal-custom-data/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Insert Institutional Proposal Custom DataPOST/instprop/api/v1/institutional-proposal-custom-data/
Example URI
POST /instprop/api/v1/institutional-proposal-custom-data/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Institutional Proposal Custom DataPOST/instprop/api/v1/institutional-proposal-custom-data/
Example URI
POST /instprop/api/v1/institutional-proposal-custom-data/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"customAttributeId": "(val)",
"proposalCustomDataId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Delete Institutional Proposal Custom Data by KeyDELETE/instprop/api/v1/institutional-proposal-custom-data/(key)
Example URI
DELETE /instprop/api/v1/institutional-proposal-custom-data/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Institutional Proposal Custom DataDELETE/instprop/api/v1/institutional-proposal-custom-data/
Example URI
DELETE /instprop/api/v1/institutional-proposal-custom-data/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Institutional Proposal Custom Data with MatchingDELETE/instprop/api/v1/institutional-proposal-custom-data/
Example URI
DELETE /instprop/api/v1/institutional-proposal-custom-data/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- institutionalProposal.proposalId
string(optional)- customAttributeId
string(optional)Custom Attribute Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- proposalCustomDataId
string(optional)Proposal Custom Data Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- proposalNumber
string(optional)Proposal Number. Maximum length is 10. Validating pattern is ^[A-Za-z0-9]*$.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.
- value
string(optional)Value. Maximum length is 2000. Validating pattern is ^[\u0000-\uFFFF]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalInstitutional Proposal Notepads ¶
Get Institutional Proposal Notepads by KeyGET/instprop/api/v1/institutional-proposal-notepads/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-notepads/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"institutionalProposal.proposalId": "(val)",
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"entryNumber": "(val)",
"noteId": "(val)",
"noteTopic": "(val)",
"proposalNotepadId": "(val)",
"proposalNumber": "(val)",
"restrictedView": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal NotepadsGET/instprop/api/v1/institutional-proposal-notepads/
Example URI
GET /instprop/api/v1/institutional-proposal-notepads/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposal.proposalId": "(val)",
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"entryNumber": "(val)",
"noteId": "(val)",
"noteTopic": "(val)",
"proposalNotepadId": "(val)",
"proposalNumber": "(val)",
"restrictedView": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"entryNumber": "(val)",
"noteId": "(val)",
"noteTopic": "(val)",
"proposalNotepadId": "(val)",
"proposalNumber": "(val)",
"restrictedView": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Notepads with FilteringGET/instprop/api/v1/institutional-proposal-notepads/
Example URI
GET /instprop/api/v1/institutional-proposal-notepads/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- institutionalProposal.proposalId
string(optional)- comments
string(optional)Comments. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- createTimestamp
string(optional)Posted Timestamp. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- createUser
string(optional)- entryNumber
string(optional)Entry Number. Maximum length is 22. Validating pattern is ^[0-9]*$.
- noteId
string(optional)- noteTopic
string(optional)Comments. Maximum length is 60. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- proposalNotepadId
string(optional)Proposal Notepad Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- restrictedView
string(optional)Restricted View. Maximum length is 1. Validating pattern is .*.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposal.proposalId": "(val)",
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"entryNumber": "(val)",
"noteId": "(val)",
"noteTopic": "(val)",
"proposalNotepadId": "(val)",
"proposalNumber": "(val)",
"restrictedView": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"entryNumber": "(val)",
"noteId": "(val)",
"noteTopic": "(val)",
"proposalNotepadId": "(val)",
"proposalNumber": "(val)",
"restrictedView": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal NotepadsGET/instprop/api/v1/institutional-proposal-notepads/
Example URI
GET /instprop/api/v1/institutional-proposal-notepads/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"institutionalProposal.proposalId",
"comments",
"createTimestamp",
"createUser",
"entryNumber",
"noteId",
"noteTopic",
"proposalNotepadId",
"proposalNumber",
"restrictedView"
],
"primaryKey": "proposalNotepadId"
}Get Blueprint API specification for Institutional Proposal NotepadsGET/instprop/api/v1/institutional-proposal-notepads/
Example URI
GET /instprop/api/v1/institutional-proposal-notepads/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Notepads.md"
transfer-encoding: chunkedInstitutional Proposal Person Credit Splits ¶
Get Institutional Proposal Person Credit Splits by KeyGET/instprop/api/v1/institutional-proposal-person-credit-splits/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-person-credit-splits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal Person Credit SplitsGET/instprop/api/v1/institutional-proposal-person-credit-splits/
Example URI
GET /instprop/api/v1/institutional-proposal-person-credit-splits/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Person Credit Splits with FilteringGET/instprop/api/v1/institutional-proposal-person-credit-splits/
Example URI
GET /instprop/api/v1/institutional-proposal-person-credit-splits/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- credit
string(optional)Credit. Maximum length is 6. Validating pattern is ^([0-9]{0,4}.[0-9]{1,2}|[0-9]{1,4})$.
- institutionalProposalContactId
string(optional)- institutionalProposalPersonCreditSplitId
string(optional)- invCreditTypeCode
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal Person Credit SplitsGET/instprop/api/v1/institutional-proposal-person-credit-splits/
Example URI
GET /instprop/api/v1/institutional-proposal-person-credit-splits/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"credit",
"institutionalProposalContactId",
"institutionalProposalPersonCreditSplitId",
"invCreditTypeCode"
],
"primaryKey": "institutionalProposalPersonCreditSplitId"
}Get Blueprint API specification for Institutional Proposal Person Credit SplitsGET/instprop/api/v1/institutional-proposal-person-credit-splits/
Example URI
GET /instprop/api/v1/institutional-proposal-person-credit-splits/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Person Credit Splits.md"
transfer-encoding: chunkedUpdate Institutional Proposal Person Credit SplitsPUT/instprop/api/v1/institutional-proposal-person-credit-splits/(key)
Example URI
PUT /instprop/api/v1/institutional-proposal-person-credit-splits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Institutional Proposal Person Credit SplitsPUT/instprop/api/v1/institutional-proposal-person-credit-splits/
Example URI
PUT /instprop/api/v1/institutional-proposal-person-credit-splits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Institutional Proposal Person Credit SplitsPATCH/instprop/api/v1/institutional-proposal-person-credit-splits/(key)
Example URI
PATCH /instprop/api/v1/institutional-proposal-person-credit-splits/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Institutional Proposal Person Credit SplitsPOST/instprop/api/v1/institutional-proposal-person-credit-splits/
Example URI
POST /instprop/api/v1/institutional-proposal-person-credit-splits/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Institutional Proposal Person Credit SplitsPOST/instprop/api/v1/institutional-proposal-person-credit-splits/
Example URI
POST /instprop/api/v1/institutional-proposal-person-credit-splits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"credit": "(val)",
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonCreditSplitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Institutional Proposal Person Credit Splits by KeyDELETE/instprop/api/v1/institutional-proposal-person-credit-splits/(key)
Example URI
DELETE /instprop/api/v1/institutional-proposal-person-credit-splits/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Institutional Proposal Person Credit SplitsDELETE/instprop/api/v1/institutional-proposal-person-credit-splits/
Example URI
DELETE /instprop/api/v1/institutional-proposal-person-credit-splits/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Institutional Proposal Person Credit Splits with MatchingDELETE/instprop/api/v1/institutional-proposal-person-credit-splits/
Example URI
DELETE /instprop/api/v1/institutional-proposal-person-credit-splits/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- credit
string(optional)Credit. Maximum length is 6. Validating pattern is ^([0-9]{0,4}.[0-9]{1,2}|[0-9]{1,4})$.
- institutionalProposalContactId
string(optional)- institutionalProposalPersonCreditSplitId
string(optional)- invCreditTypeCode
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalInstitutional Proposal Person Mass Changes ¶
Get Institutional Proposal Person Mass Changes by KeyGET/instprop/api/v1/institutional-proposal-person-mass-changes/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal Person Mass ChangesGET/instprop/api/v1/institutional-proposal-person-mass-changes/
Example URI
GET /instprop/api/v1/institutional-proposal-person-mass-changes/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Person Mass Changes with FilteringGET/instprop/api/v1/institutional-proposal-person-mass-changes/
Example URI
GET /instprop/api/v1/institutional-proposal-person-mass-changes/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- institutionalProposalPersonMassChangeId
string(optional)Institutional Proposal Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.
- investigator
string(optional)Investigator. Maximum length is 1. Validating pattern is .*.
- ipReviewer
string(optional)IP Reviewer. Maximum length is 1. Validating pattern is .*.
- keyStudyPerson
string(optional)Key Study Person. Maximum length is 1. Validating pattern is .*.
- mailingInformation
string(optional)Mailing Information. Maximum length is 1. Validating pattern is .*.
- personMassChangeId
string(optional)Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.
- unitContact
string(optional)Unit Contact. Maximum length is 1. Validating pattern is .*.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal Person Mass ChangesGET/instprop/api/v1/institutional-proposal-person-mass-changes/
Example URI
GET /instprop/api/v1/institutional-proposal-person-mass-changes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"institutionalProposalPersonMassChangeId",
"investigator",
"ipReviewer",
"keyStudyPerson",
"mailingInformation",
"personMassChangeId",
"unitContact"
],
"primaryKey": "institutionalProposalPersonMassChangeId"
}Get Blueprint API specification for Institutional Proposal Person Mass ChangesGET/instprop/api/v1/institutional-proposal-person-mass-changes/
Example URI
GET /instprop/api/v1/institutional-proposal-person-mass-changes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Person Mass Changes.md"
transfer-encoding: chunkedUpdate Institutional Proposal Person Mass ChangesPUT/instprop/api/v1/institutional-proposal-person-mass-changes/(key)
Example URI
PUT /instprop/api/v1/institutional-proposal-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Institutional Proposal Person Mass ChangesPUT/instprop/api/v1/institutional-proposal-person-mass-changes/
Example URI
PUT /instprop/api/v1/institutional-proposal-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Institutional Proposal Person Mass ChangesPATCH/instprop/api/v1/institutional-proposal-person-mass-changes/(key)
Example URI
PATCH /instprop/api/v1/institutional-proposal-person-mass-changes/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
}Insert Institutional Proposal Person Mass ChangesPOST/instprop/api/v1/institutional-proposal-person-mass-changes/
Example URI
POST /instprop/api/v1/institutional-proposal-person-mass-changes/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Institutional Proposal Person Mass ChangesPOST/instprop/api/v1/institutional-proposal-person-mass-changes/
Example URI
POST /instprop/api/v1/institutional-proposal-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalPersonMassChangeId": "(val)",
"investigator": "(val)",
"ipReviewer": "(val)",
"keyStudyPerson": "(val)",
"mailingInformation": "(val)",
"personMassChangeId": "(val)",
"unitContact": "(val)",
"_primaryKey": "(val)"
}
]Delete Institutional Proposal Person Mass Changes by KeyDELETE/instprop/api/v1/institutional-proposal-person-mass-changes/(key)
Example URI
DELETE /instprop/api/v1/institutional-proposal-person-mass-changes/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Institutional Proposal Person Mass ChangesDELETE/instprop/api/v1/institutional-proposal-person-mass-changes/
Example URI
DELETE /instprop/api/v1/institutional-proposal-person-mass-changes/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Institutional Proposal Person Mass Changes with MatchingDELETE/instprop/api/v1/institutional-proposal-person-mass-changes/
Example URI
DELETE /instprop/api/v1/institutional-proposal-person-mass-changes/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- institutionalProposalPersonMassChangeId
string(optional)Institutional Proposal Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.
- investigator
string(optional)Investigator. Maximum length is 1. Validating pattern is .*.
- ipReviewer
string(optional)IP Reviewer. Maximum length is 1. Validating pattern is .*.
- keyStudyPerson
string(optional)Key Study Person. Maximum length is 1. Validating pattern is .*.
- mailingInformation
string(optional)Mailing Information. Maximum length is 1. Validating pattern is .*.
- personMassChangeId
string(optional)Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.
- unitContact
string(optional)Unit Contact. Maximum length is 1. Validating pattern is .*.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalInstitutional Proposal Person Unit Credit Splits ¶
Get Institutional Proposal Person Unit Credit Splits by KeyGET/instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal Person Unit Credit SplitsGET/instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Example URI
GET /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Person Unit Credit Splits with FilteringGET/instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Example URI
GET /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- credit
string(optional)Credit. Maximum length is 6. Validating pattern is ^([0-9]{0,4}.[0-9]{1,2}|[0-9]{1,4})$.
- institutionalProposalPersonUnitCreditSplitId
string(optional)- institutionalProposalPersonUnitId
string(optional)- invCreditTypeCode
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal Person Unit Credit SplitsGET/instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Example URI
GET /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"credit",
"institutionalProposalPersonUnitCreditSplitId",
"institutionalProposalPersonUnitId",
"invCreditTypeCode"
],
"primaryKey": "institutionalProposalPersonUnitCreditSplitId"
}Get Blueprint API specification for Institutional Proposal Person Unit Credit SplitsGET/instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Example URI
GET /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Person Unit Credit Splits.md"
transfer-encoding: chunkedUpdate Institutional Proposal Person Unit Credit SplitsPUT/instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)
Example URI
PUT /instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Institutional Proposal Person Unit Credit SplitsPUT/instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Example URI
PUT /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Institutional Proposal Person Unit Credit SplitsPATCH/instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)
Example URI
PATCH /instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Institutional Proposal Person Unit Credit SplitsPOST/instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Example URI
POST /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Institutional Proposal Person Unit Credit SplitsPOST/instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Example URI
POST /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"credit": "(val)",
"institutionalProposalPersonUnitCreditSplitId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"invCreditTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Institutional Proposal Person Unit Credit Splits by KeyDELETE/instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)
Example URI
DELETE /instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Institutional Proposal Person Unit Credit SplitsDELETE/instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Example URI
DELETE /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Institutional Proposal Person Unit Credit Splits with MatchingDELETE/instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Example URI
DELETE /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- credit
string(optional)Credit. Maximum length is 6. Validating pattern is ^([0-9]{0,4}.[0-9]{1,2}|[0-9]{1,4})$.
- institutionalProposalPersonUnitCreditSplitId
string(optional)- institutionalProposalPersonUnitId
string(optional)- invCreditTypeCode
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalInstitutional Proposal Person Units ¶
Get Institutional Proposal Person Units by KeyGET/instprop/api/v1/institutional-proposal-person-units/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-person-units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal Person UnitsGET/instprop/api/v1/institutional-proposal-person-units/
Example URI
GET /instprop/api/v1/institutional-proposal-person-units/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Person Units with FilteringGET/instprop/api/v1/institutional-proposal-person-units/
Example URI
GET /instprop/api/v1/institutional-proposal-person-units/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- institutionalProposalContactId
string(optional)- institutionalProposalPersonUnitId
string(optional)InstitutionalProposalPersonUnit ID. Maximum length is 8. Validating pattern is ^[0-9]*$.
- leadUnit
string(optional)Lead Unit flag. Maximum length is 1. Validating pattern is .*.
- unitNumber
string(optional)Unit Number. Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal Person UnitsGET/instprop/api/v1/institutional-proposal-person-units/
Example URI
GET /instprop/api/v1/institutional-proposal-person-units/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"institutionalProposalContactId",
"institutionalProposalPersonUnitId",
"leadUnit",
"unitNumber"
],
"primaryKey": "institutionalProposalPersonUnitId"
}Get Blueprint API specification for Institutional Proposal Person UnitsGET/instprop/api/v1/institutional-proposal-person-units/
Example URI
GET /instprop/api/v1/institutional-proposal-person-units/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Person Units.md"
transfer-encoding: chunkedUpdate Institutional Proposal Person UnitsPUT/instprop/api/v1/institutional-proposal-person-units/(key)
Example URI
PUT /instprop/api/v1/institutional-proposal-person-units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Institutional Proposal Person UnitsPUT/instprop/api/v1/institutional-proposal-person-units/
Example URI
PUT /instprop/api/v1/institutional-proposal-person-units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Institutional Proposal Person UnitsPATCH/instprop/api/v1/institutional-proposal-person-units/(key)
Example URI
PATCH /instprop/api/v1/institutional-proposal-person-units/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Insert Institutional Proposal Person UnitsPOST/instprop/api/v1/institutional-proposal-person-units/
Example URI
POST /instprop/api/v1/institutional-proposal-person-units/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Institutional Proposal Person UnitsPOST/instprop/api/v1/institutional-proposal-person-units/
Example URI
POST /instprop/api/v1/institutional-proposal-person-units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalContactId": "(val)",
"institutionalProposalPersonUnitId": "(val)",
"leadUnit": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Institutional Proposal Person Units by KeyDELETE/instprop/api/v1/institutional-proposal-person-units/(key)
Example URI
DELETE /instprop/api/v1/institutional-proposal-person-units/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Institutional Proposal Person UnitsDELETE/instprop/api/v1/institutional-proposal-person-units/
Example URI
DELETE /instprop/api/v1/institutional-proposal-person-units/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Institutional Proposal Person Units with MatchingDELETE/instprop/api/v1/institutional-proposal-person-units/
Example URI
DELETE /instprop/api/v1/institutional-proposal-person-units/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- institutionalProposalContactId
string(optional)- institutionalProposalPersonUnitId
string(optional)InstitutionalProposalPersonUnit ID. Maximum length is 8. Validating pattern is ^[0-9]*$.
- leadUnit
string(optional)Lead Unit flag. Maximum length is 1. Validating pattern is .*.
- unitNumber
string(optional)Unit Number. Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalInstitutional Proposal Persons ¶
Get Institutional Proposal Persons by KeyGET/instprop/api/v1/institutional-proposal-persons/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-persons/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"institutionalProposal.proposalId": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"canPassivelyDiscloseCois": "(val)",
"faculty": "(val)",
"fullName": "(val)",
"includeInCreditAllocation": "(val)",
"institutionalProposalContactId": "(val)",
"keyPersonRole": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"roleCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal PersonsGET/instprop/api/v1/institutional-proposal-persons/
Example URI
GET /instprop/api/v1/institutional-proposal-persons/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposal.proposalId": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"canPassivelyDiscloseCois": "(val)",
"faculty": "(val)",
"fullName": "(val)",
"includeInCreditAllocation": "(val)",
"institutionalProposalContactId": "(val)",
"keyPersonRole": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"roleCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"canPassivelyDiscloseCois": "(val)",
"faculty": "(val)",
"fullName": "(val)",
"includeInCreditAllocation": "(val)",
"institutionalProposalContactId": "(val)",
"keyPersonRole": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"roleCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Persons with FilteringGET/instprop/api/v1/institutional-proposal-persons/
Example URI
GET /instprop/api/v1/institutional-proposal-persons/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- institutionalProposal.proposalId
string(optional)- academicYearEffort
string(optional)Academic Year Effort. Maximum length is 7. Validating pattern is ^([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.
- calendarYearEffort
string(optional)Calendar Year Effort. Maximum length is 7. Validating pattern is ^([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.
- canPassivelyDiscloseCois
string(optional)Disclosure Required. Maximum length is 1. Validating pattern is .*.
- faculty
string(optional)Faculty flag. Maximum length is 1. Validating pattern is .*.
- fullName
string(optional)Full Name. Maximum length is 165. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- includeInCreditAllocation
string(optional)Include in Credit Allocation. Maximum length is 1. Validating pattern is .*.
- institutionalProposalContactId
string(optional)InstitutionalProposal Contact ID. Maximum length is 8. Validating pattern is ^[0-9]*$.
- keyPersonRole
string(optional)Project Role. Maximum length is 60. Validating pattern is .*.
- personId
string(optional)- proposalNumber
string(optional)Institutional Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- roleCode
string(optional)- rolodexId
string(optional)- sequenceNumber
string(optional)Sequence Number. Maximum length is 4. Validating pattern is ^[0-9]*$.
- summerEffort
string(optional)Summer Effort. Maximum length is 7. Validating pattern is ^([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.
- totalEffort
string(optional)Total Effort. Maximum length is 7. Validating pattern is ^([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposal.proposalId": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"canPassivelyDiscloseCois": "(val)",
"faculty": "(val)",
"fullName": "(val)",
"includeInCreditAllocation": "(val)",
"institutionalProposalContactId": "(val)",
"keyPersonRole": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"roleCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"canPassivelyDiscloseCois": "(val)",
"faculty": "(val)",
"fullName": "(val)",
"includeInCreditAllocation": "(val)",
"institutionalProposalContactId": "(val)",
"keyPersonRole": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"roleCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal PersonsGET/instprop/api/v1/institutional-proposal-persons/
Example URI
GET /instprop/api/v1/institutional-proposal-persons/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"institutionalProposal.proposalId",
"academicYearEffort",
"calendarYearEffort",
"canPassivelyDiscloseCois",
"faculty",
"fullName",
"includeInCreditAllocation",
"institutionalProposalContactId",
"keyPersonRole",
"personId",
"proposalNumber",
"roleCode",
"rolodexId",
"sequenceNumber",
"summerEffort",
"totalEffort"
],
"primaryKey": "institutionalProposalContactId"
}Get Blueprint API specification for Institutional Proposal PersonsGET/instprop/api/v1/institutional-proposal-persons/
Example URI
GET /instprop/api/v1/institutional-proposal-persons/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Persons.md"
transfer-encoding: chunkedUpdate Institutional Proposal PersonsPUT/instprop/api/v1/institutional-proposal-persons/(key)
Example URI
PUT /instprop/api/v1/institutional-proposal-persons/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"institutionalProposal.proposalId": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"canPassivelyDiscloseCois": "(val)",
"faculty": "(val)",
"fullName": "(val)",
"includeInCreditAllocation": "(val)",
"institutionalProposalContactId": "(val)",
"keyPersonRole": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"roleCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Institutional Proposal PersonsPUT/instprop/api/v1/institutional-proposal-persons/
Example URI
PUT /instprop/api/v1/institutional-proposal-persons/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"institutionalProposal.proposalId": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"canPassivelyDiscloseCois": "(val)",
"faculty": "(val)",
"fullName": "(val)",
"includeInCreditAllocation": "(val)",
"institutionalProposalContactId": "(val)",
"keyPersonRole": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"roleCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"canPassivelyDiscloseCois": "(val)",
"faculty": "(val)",
"fullName": "(val)",
"includeInCreditAllocation": "(val)",
"institutionalProposalContactId": "(val)",
"keyPersonRole": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"roleCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Institutional Proposal PersonsPATCH/instprop/api/v1/institutional-proposal-persons/(key)
Example URI
PATCH /instprop/api/v1/institutional-proposal-persons/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"institutionalProposal.proposalId": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"canPassivelyDiscloseCois": "(val)",
"faculty": "(val)",
"fullName": "(val)",
"includeInCreditAllocation": "(val)",
"institutionalProposalContactId": "(val)",
"keyPersonRole": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"roleCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"summerEffort": "(val)",
"totalEffort": "(val)",
"_primaryKey": "(val)"
}Institutional Proposal Science Keywords ¶
Get Institutional Proposal Science Keywords by KeyGET/instprop/api/v1/institutional-proposal-science-keywords/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-science-keywords/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"institutionalProposal.proposalId": "(val)",
"proposalNumber": "(val)",
"proposalScienceKeywordId": "(val)",
"scienceKeywordCode": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal Science KeywordsGET/instprop/api/v1/institutional-proposal-science-keywords/
Example URI
GET /instprop/api/v1/institutional-proposal-science-keywords/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposal.proposalId": "(val)",
"proposalNumber": "(val)",
"proposalScienceKeywordId": "(val)",
"scienceKeywordCode": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"proposalNumber": "(val)",
"proposalScienceKeywordId": "(val)",
"scienceKeywordCode": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Science Keywords with FilteringGET/instprop/api/v1/institutional-proposal-science-keywords/
Example URI
GET /instprop/api/v1/institutional-proposal-science-keywords/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- institutionalProposal.proposalId
string(optional)- proposalNumber
string(optional)Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- proposalScienceKeywordId
string(optional)Proposal Science Code Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- scienceKeywordCode
string(optional)Science Code. Maximum length is 15. Validating pattern is ^[A-Za-z0-9]*$.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposal.proposalId": "(val)",
"proposalNumber": "(val)",
"proposalScienceKeywordId": "(val)",
"scienceKeywordCode": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"proposalNumber": "(val)",
"proposalScienceKeywordId": "(val)",
"scienceKeywordCode": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal Science KeywordsGET/instprop/api/v1/institutional-proposal-science-keywords/
Example URI
GET /instprop/api/v1/institutional-proposal-science-keywords/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"institutionalProposal.proposalId",
"proposalNumber",
"proposalScienceKeywordId",
"scienceKeywordCode",
"sequenceNumber"
],
"primaryKey": "proposalScienceKeywordId"
}Get Blueprint API specification for Institutional Proposal Science KeywordsGET/instprop/api/v1/institutional-proposal-science-keywords/
Example URI
GET /instprop/api/v1/institutional-proposal-science-keywords/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Science Keywords.md"
transfer-encoding: chunkedInstitutional Proposal Special Review Exemptions ¶
Get Institutional Proposal Special Review Exemptions by KeyGET/instprop/api/v1/institutional-proposal-special-review-exemptions/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-special-review-exemptions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal Special Review ExemptionsGET/instprop/api/v1/institutional-proposal-special-review-exemptions/
Example URI
GET /instprop/api/v1/institutional-proposal-special-review-exemptions/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Special Review Exemptions with FilteringGET/instprop/api/v1/institutional-proposal-special-review-exemptions/
Example URI
GET /instprop/api/v1/institutional-proposal-special-review-exemptions/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- institutionalProposalSpecialReview.proposalSpecialReviewId
string(optional)- exemptionTypeCode
string(optional)Exemption #. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- proposalSpecialReviewExemptionId
string(optional)Proposal Special Review Exemption Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal Special Review ExemptionsGET/instprop/api/v1/institutional-proposal-special-review-exemptions/
Example URI
GET /instprop/api/v1/institutional-proposal-special-review-exemptions/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"institutionalProposalSpecialReview.proposalSpecialReviewId",
"exemptionTypeCode",
"proposalSpecialReviewExemptionId"
],
"primaryKey": "proposalSpecialReviewExemptionId"
}Get Blueprint API specification for Institutional Proposal Special Review ExemptionsGET/instprop/api/v1/institutional-proposal-special-review-exemptions/
Example URI
GET /instprop/api/v1/institutional-proposal-special-review-exemptions/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Special Review Exemptions.md"
transfer-encoding: chunkedUpdate Institutional Proposal Special Review ExemptionsPUT/instprop/api/v1/institutional-proposal-special-review-exemptions/(key)
Example URI
PUT /instprop/api/v1/institutional-proposal-special-review-exemptions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Institutional Proposal Special Review ExemptionsPUT/instprop/api/v1/institutional-proposal-special-review-exemptions/
Example URI
PUT /instprop/api/v1/institutional-proposal-special-review-exemptions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Institutional Proposal Special Review ExemptionsPATCH/instprop/api/v1/institutional-proposal-special-review-exemptions/(key)
Example URI
PATCH /instprop/api/v1/institutional-proposal-special-review-exemptions/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
}Insert Institutional Proposal Special Review ExemptionsPOST/instprop/api/v1/institutional-proposal-special-review-exemptions/
Example URI
POST /instprop/api/v1/institutional-proposal-special-review-exemptions/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Institutional Proposal Special Review ExemptionsPOST/instprop/api/v1/institutional-proposal-special-review-exemptions/
Example URI
POST /instprop/api/v1/institutional-proposal-special-review-exemptions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
"exemptionTypeCode": "(val)",
"proposalSpecialReviewExemptionId": "(val)",
"_primaryKey": "(val)"
}
]Delete Institutional Proposal Special Review Exemptions by KeyDELETE/instprop/api/v1/institutional-proposal-special-review-exemptions/(key)
Example URI
DELETE /instprop/api/v1/institutional-proposal-special-review-exemptions/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Institutional Proposal Special Review ExemptionsDELETE/instprop/api/v1/institutional-proposal-special-review-exemptions/
Example URI
DELETE /instprop/api/v1/institutional-proposal-special-review-exemptions/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Institutional Proposal Special Review Exemptions with MatchingDELETE/instprop/api/v1/institutional-proposal-special-review-exemptions/
Example URI
DELETE /instprop/api/v1/institutional-proposal-special-review-exemptions/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- institutionalProposalSpecialReview.proposalSpecialReviewId
string(optional)- exemptionTypeCode
string(optional)Exemption #. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- proposalSpecialReviewExemptionId
string(optional)Proposal Special Review Exemption Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalInstitutional Proposal Special Reviews ¶
Get Institutional Proposal Special Reviews by KeyGET/instprop/api/v1/institutional-proposal-special-reviews/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-special-reviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"sequenceOwner.proposalId": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"approvalTypeCode": "(val)",
"comments": "(val)",
"expirationDate": "(val)",
"proposalSpecialReviewId": "(val)",
"protocolNumber": "(val)",
"protocolStatus": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal Special ReviewsGET/instprop/api/v1/institutional-proposal-special-reviews/
Example URI
GET /instprop/api/v1/institutional-proposal-special-reviews/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"sequenceOwner.proposalId": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"approvalTypeCode": "(val)",
"comments": "(val)",
"expirationDate": "(val)",
"proposalSpecialReviewId": "(val)",
"protocolNumber": "(val)",
"protocolStatus": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"sequenceOwner.proposalId": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"approvalTypeCode": "(val)",
"comments": "(val)",
"expirationDate": "(val)",
"proposalSpecialReviewId": "(val)",
"protocolNumber": "(val)",
"protocolStatus": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Special Reviews with FilteringGET/instprop/api/v1/institutional-proposal-special-reviews/
Example URI
GET /instprop/api/v1/institutional-proposal-special-reviews/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- sequenceOwner.proposalId
string(optional)- applicationDate
string(optional)Application Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- approvalDate
string(optional)Approval Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- approvalTypeCode
string(optional)Approval Status Type Code. Maximum length is 30. Validating pattern is ^[\p{Graph}]*$.
- comments
string(optional)Comments. Maximum length is 2000. Validating pattern is .*.
- expirationDate
string(optional)Expiration Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- proposalSpecialReviewId
string(optional)Proposal Special Review Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- protocolNumber
string(optional)Compliance Identifier. Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- protocolStatus
string(optional)Protocol Status. Maximum length is 200. Validating pattern is ^[\u0000-\uFFFF]*$.
- specialReviewNumber
string(optional)Special Review Number. Maximum length is 22. Validating pattern is ^[0-9]*$.
- specialReviewTypeCode
string(optional)Special Review Type Code. Maximum length is 30. Validating pattern is ^[\p{Graph}]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"sequenceOwner.proposalId": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"approvalTypeCode": "(val)",
"comments": "(val)",
"expirationDate": "(val)",
"proposalSpecialReviewId": "(val)",
"protocolNumber": "(val)",
"protocolStatus": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"sequenceOwner.proposalId": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"approvalTypeCode": "(val)",
"comments": "(val)",
"expirationDate": "(val)",
"proposalSpecialReviewId": "(val)",
"protocolNumber": "(val)",
"protocolStatus": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal Special ReviewsGET/instprop/api/v1/institutional-proposal-special-reviews/
Example URI
GET /instprop/api/v1/institutional-proposal-special-reviews/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"sequenceOwner.proposalId",
"applicationDate",
"approvalDate",
"approvalTypeCode",
"comments",
"expirationDate",
"proposalSpecialReviewId",
"protocolNumber",
"protocolStatus",
"specialReviewNumber",
"specialReviewTypeCode"
],
"primaryKey": "proposalSpecialReviewId"
}Get Blueprint API specification for Institutional Proposal Special ReviewsGET/instprop/api/v1/institutional-proposal-special-reviews/
Example URI
GET /instprop/api/v1/institutional-proposal-special-reviews/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Special Reviews.md"
transfer-encoding: chunkedUpdate Institutional Proposal Special ReviewsPUT/instprop/api/v1/institutional-proposal-special-reviews/(key)
Example URI
PUT /instprop/api/v1/institutional-proposal-special-reviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sequenceOwner.proposalId": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"approvalTypeCode": "(val)",
"comments": "(val)",
"expirationDate": "(val)",
"proposalSpecialReviewId": "(val)",
"protocolNumber": "(val)",
"protocolStatus": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Institutional Proposal Special ReviewsPUT/instprop/api/v1/institutional-proposal-special-reviews/
Example URI
PUT /instprop/api/v1/institutional-proposal-special-reviews/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sequenceOwner.proposalId": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"approvalTypeCode": "(val)",
"comments": "(val)",
"expirationDate": "(val)",
"proposalSpecialReviewId": "(val)",
"protocolNumber": "(val)",
"protocolStatus": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"sequenceOwner.proposalId": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"approvalTypeCode": "(val)",
"comments": "(val)",
"expirationDate": "(val)",
"proposalSpecialReviewId": "(val)",
"protocolNumber": "(val)",
"protocolStatus": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Institutional Proposal Special ReviewsPATCH/instprop/api/v1/institutional-proposal-special-reviews/(key)
Example URI
PATCH /instprop/api/v1/institutional-proposal-special-reviews/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"sequenceOwner.proposalId": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"approvalTypeCode": "(val)",
"comments": "(val)",
"expirationDate": "(val)",
"proposalSpecialReviewId": "(val)",
"protocolNumber": "(val)",
"protocolStatus": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}Institutional Proposal Unit Contacts ¶
Get Institutional Proposal Unit Contacts by KeyGET/instprop/api/v1/institutional-proposal-unit-contacts/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-unit-contacts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"institutionalProposal.proposalId": "(val)",
"fullName": "(val)",
"institutionalProposalContactId": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitContactType": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal Unit ContactsGET/instprop/api/v1/institutional-proposal-unit-contacts/
Example URI
GET /instprop/api/v1/institutional-proposal-unit-contacts/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposal.proposalId": "(val)",
"fullName": "(val)",
"institutionalProposalContactId": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitContactType": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"fullName": "(val)",
"institutionalProposalContactId": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitContactType": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Unit Contacts with FilteringGET/instprop/api/v1/institutional-proposal-unit-contacts/
Example URI
GET /instprop/api/v1/institutional-proposal-unit-contacts/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- institutionalProposal.proposalId
string(optional)- fullName
string(optional)- institutionalProposalContactId
string(optional)- personId
string(optional)- proposalNumber
string(optional)- sequenceNumber
string(optional)- unitAdministratorTypeCode
string(optional)Project Role. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- unitContactType
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposal.proposalId": "(val)",
"fullName": "(val)",
"institutionalProposalContactId": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitContactType": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"fullName": "(val)",
"institutionalProposalContactId": "(val)",
"personId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitContactType": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal Unit ContactsGET/instprop/api/v1/institutional-proposal-unit-contacts/
Example URI
GET /instprop/api/v1/institutional-proposal-unit-contacts/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"institutionalProposal.proposalId",
"fullName",
"institutionalProposalContactId",
"personId",
"proposalNumber",
"sequenceNumber",
"unitAdministratorTypeCode",
"unitContactType"
],
"primaryKey": "institutionalProposalContactId"
}Get Blueprint API specification for Institutional Proposal Unit ContactsGET/instprop/api/v1/institutional-proposal-unit-contacts/
Example URI
GET /instprop/api/v1/institutional-proposal-unit-contacts/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Unit Contacts.md"
transfer-encoding: chunkedInstitutional Proposal Unrecovered F And As ¶
Get Institutional Proposal Unrecovered F And As by KeyGET/instprop/api/v1/institutional-proposal-unrecovered-f-and-as/(key)
Example URI
GET /instprop/api/v1/institutional-proposal-unrecovered-f-and-as/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"institutionalProposal.proposalId": "(val)",
"applicableIndirectcostRate": "(val)",
"fiscalYear": "(val)",
"indirectcostRateTypeCode": "(val)",
"onCampusFlag": "(val)",
"proposalNumber": "(val)",
"proposalUnrecoveredFandAId": "(val)",
"sequenceNumber": "(val)",
"sourceAccount": "(val)",
"underrecoveryOfIndirectcost": "(val)",
"_primaryKey": "(val)"
}Get All Institutional Proposal Unrecovered F And AsGET/instprop/api/v1/institutional-proposal-unrecovered-f-and-as/
Example URI
GET /instprop/api/v1/institutional-proposal-unrecovered-f-and-as/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposal.proposalId": "(val)",
"applicableIndirectcostRate": "(val)",
"fiscalYear": "(val)",
"indirectcostRateTypeCode": "(val)",
"onCampusFlag": "(val)",
"proposalNumber": "(val)",
"proposalUnrecoveredFandAId": "(val)",
"sequenceNumber": "(val)",
"sourceAccount": "(val)",
"underrecoveryOfIndirectcost": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"applicableIndirectcostRate": "(val)",
"fiscalYear": "(val)",
"indirectcostRateTypeCode": "(val)",
"onCampusFlag": "(val)",
"proposalNumber": "(val)",
"proposalUnrecoveredFandAId": "(val)",
"sequenceNumber": "(val)",
"sourceAccount": "(val)",
"underrecoveryOfIndirectcost": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposal Unrecovered F And As with FilteringGET/instprop/api/v1/institutional-proposal-unrecovered-f-and-as/
Example URI
GET /instprop/api/v1/institutional-proposal-unrecovered-f-and-as/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- institutionalProposal.proposalId
string(optional)- applicableIndirectcostRate
string(optional)Applicable Indirectcost Rate. Maximum length is 10. Validating pattern is ^([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.
- fiscalYear
string(optional)Fiscal Year. Maximum length is 4. Validating pattern is ^[A-Za-z0-9]*$.
- indirectcostRateTypeCode
string(optional)IDC Rate Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
- onCampusFlag
string(optional)On Campus Flag. Maximum length is 1. Validating pattern is ^[\p{Graph}]*$.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- proposalUnrecoveredFandAId
string(optional)Proposal Unrecovered FNA Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.
- sourceAccount
string(optional)Source Account. Maximum length is 32. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- underrecoveryOfIndirectcost
string(optional)Underrecovery of Indirect Cost. Maximum length is 22. Validating pattern is ^([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposal.proposalId": "(val)",
"applicableIndirectcostRate": "(val)",
"fiscalYear": "(val)",
"indirectcostRateTypeCode": "(val)",
"onCampusFlag": "(val)",
"proposalNumber": "(val)",
"proposalUnrecoveredFandAId": "(val)",
"sequenceNumber": "(val)",
"sourceAccount": "(val)",
"underrecoveryOfIndirectcost": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposal.proposalId": "(val)",
"applicableIndirectcostRate": "(val)",
"fiscalYear": "(val)",
"indirectcostRateTypeCode": "(val)",
"onCampusFlag": "(val)",
"proposalNumber": "(val)",
"proposalUnrecoveredFandAId": "(val)",
"sequenceNumber": "(val)",
"sourceAccount": "(val)",
"underrecoveryOfIndirectcost": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional Proposal Unrecovered F And AsGET/instprop/api/v1/institutional-proposal-unrecovered-f-and-as/
Example URI
GET /instprop/api/v1/institutional-proposal-unrecovered-f-and-as/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"institutionalProposal.proposalId",
"applicableIndirectcostRate",
"fiscalYear",
"indirectcostRateTypeCode",
"onCampusFlag",
"proposalNumber",
"proposalUnrecoveredFandAId",
"sequenceNumber",
"sourceAccount",
"underrecoveryOfIndirectcost"
],
"primaryKey": "proposalUnrecoveredFandAId"
}Get Blueprint API specification for Institutional Proposal Unrecovered F And AsGET/instprop/api/v1/institutional-proposal-unrecovered-f-and-as/
Example URI
GET /instprop/api/v1/institutional-proposal-unrecovered-f-and-as/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Unrecovered F And As.md"
transfer-encoding: chunkedInstitutional Proposals ¶
Get Institutional Proposals by KeyGET/instprop/api/v1/institutional-proposals/(key)
Example URI
GET /instprop/api/v1/institutional-proposals/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"institutionalProposalDocument.documentNumber": "(val)",
"activityTypeCode": "(val)",
"awardTypeCode": "(val)",
"budgetEndDate": "(val)",
"budgetId": "(val)",
"budgetStartDate": "(val)",
"coSponsorRatio": "(val)",
"coSponsorTotal": "(val)",
"costShareTotal": "(val)",
"costSharingIndicator": "(val)",
"createTimestamp": "(val)",
"currentAccountNumber": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"deadlineType": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"gradStudHeadcount": "(val)",
"gradStudPersonMonths": "(val)",
"hpcCoreHours": "(val)",
"idcRateIndicator": "(val)",
"initialContractAdmin": "(val)",
"ipReviewActivityIndicator": "(val)",
"mailAccountNumber": "(val)",
"mailBy": "(val)",
"mailDescription": "(val)",
"mailType": "(val)",
"noticeOfOpportunityCode": "(val)",
"nsfSequenceNumber": "(val)",
"numberOfCopies": "(val)",
"opportunity": "(val)",
"primeSponsorCode": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"proposalSequenceStatus": "(val)",
"proposalTypeCode": "(val)",
"requestedEndDateInitial": "(val)",
"requestedEndDateTotal": "(val)",
"requestedStartDateInitial": "(val)",
"requestedStartDateTotal": "(val)",
"rolodexId": "(val)",
"scienceCodeIndicator": "(val)",
"sequenceNumber": "(val)",
"specialReviewIndicator": "(val)",
"sponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"statusCode": "(val)",
"subcontractFlag": "(val)",
"title": "(val)",
"totalDirectCostInitial": "(val)",
"totalDirectCostTotal": "(val)",
"totalIndirectCostInitial": "(val)",
"totalIndirectCostTotal": "(val)",
"typeOfAccount": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Get All Institutional ProposalsGET/instprop/api/v1/institutional-proposals/
Example URI
GET /instprop/api/v1/institutional-proposals/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposalDocument.documentNumber": "(val)",
"activityTypeCode": "(val)",
"awardTypeCode": "(val)",
"budgetEndDate": "(val)",
"budgetId": "(val)",
"budgetStartDate": "(val)",
"coSponsorRatio": "(val)",
"coSponsorTotal": "(val)",
"costShareTotal": "(val)",
"costSharingIndicator": "(val)",
"createTimestamp": "(val)",
"currentAccountNumber": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"deadlineType": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"gradStudHeadcount": "(val)",
"gradStudPersonMonths": "(val)",
"hpcCoreHours": "(val)",
"idcRateIndicator": "(val)",
"initialContractAdmin": "(val)",
"ipReviewActivityIndicator": "(val)",
"mailAccountNumber": "(val)",
"mailBy": "(val)",
"mailDescription": "(val)",
"mailType": "(val)",
"noticeOfOpportunityCode": "(val)",
"nsfSequenceNumber": "(val)",
"numberOfCopies": "(val)",
"opportunity": "(val)",
"primeSponsorCode": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"proposalSequenceStatus": "(val)",
"proposalTypeCode": "(val)",
"requestedEndDateInitial": "(val)",
"requestedEndDateTotal": "(val)",
"requestedStartDateInitial": "(val)",
"requestedStartDateTotal": "(val)",
"rolodexId": "(val)",
"scienceCodeIndicator": "(val)",
"sequenceNumber": "(val)",
"specialReviewIndicator": "(val)",
"sponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"statusCode": "(val)",
"subcontractFlag": "(val)",
"title": "(val)",
"totalDirectCostInitial": "(val)",
"totalDirectCostTotal": "(val)",
"totalIndirectCostInitial": "(val)",
"totalIndirectCostTotal": "(val)",
"typeOfAccount": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalDocument.documentNumber": "(val)",
"activityTypeCode": "(val)",
"awardTypeCode": "(val)",
"budgetEndDate": "(val)",
"budgetId": "(val)",
"budgetStartDate": "(val)",
"coSponsorRatio": "(val)",
"coSponsorTotal": "(val)",
"costShareTotal": "(val)",
"costSharingIndicator": "(val)",
"createTimestamp": "(val)",
"currentAccountNumber": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"deadlineType": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"gradStudHeadcount": "(val)",
"gradStudPersonMonths": "(val)",
"hpcCoreHours": "(val)",
"idcRateIndicator": "(val)",
"initialContractAdmin": "(val)",
"ipReviewActivityIndicator": "(val)",
"mailAccountNumber": "(val)",
"mailBy": "(val)",
"mailDescription": "(val)",
"mailType": "(val)",
"noticeOfOpportunityCode": "(val)",
"nsfSequenceNumber": "(val)",
"numberOfCopies": "(val)",
"opportunity": "(val)",
"primeSponsorCode": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"proposalSequenceStatus": "(val)",
"proposalTypeCode": "(val)",
"requestedEndDateInitial": "(val)",
"requestedEndDateTotal": "(val)",
"requestedStartDateInitial": "(val)",
"requestedStartDateTotal": "(val)",
"rolodexId": "(val)",
"scienceCodeIndicator": "(val)",
"sequenceNumber": "(val)",
"specialReviewIndicator": "(val)",
"sponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"statusCode": "(val)",
"subcontractFlag": "(val)",
"title": "(val)",
"totalDirectCostInitial": "(val)",
"totalDirectCostTotal": "(val)",
"totalIndirectCostInitial": "(val)",
"totalIndirectCostTotal": "(val)",
"typeOfAccount": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Institutional Proposals with FilteringGET/instprop/api/v1/institutional-proposals/
Example URI
GET /instprop/api/v1/institutional-proposals/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- institutionalProposalDocument.documentNumber
string(optional)- activityTypeCode
string(optional)Activity Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
- awardTypeCode
string(optional)Award Type Code. Maximum length is 15. Validating pattern is ^[\p{Graph}]*$.
- budgetEndDate
string(optional)The End Date of the Final Budget attached to this Proposal. Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- budgetId
string(optional)Budget Id. Maximum length is 50. Validating pattern is .*.
- budgetStartDate
string(optional)The Start Date of the Final Budget attached to this Proposal. Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- coSponsorRatio
string(optional)Horatio. Maximum length is 6. Validating pattern is .*.
- coSponsorTotal
string(optional)Co Sponsor Total. Maximum length is 100. Validating pattern is .*.
- costShareTotal
string(optional)Cost Share Total. Maximum length is 100. Validating pattern is .*.
- costSharingIndicator
string(optional)This attribute should always be overridden on the descriptive elements. Maximum length is 1. Validating pattern is .*.
- createTimestamp
string(optional)Proposal Create Date. Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- currentAccountNumber
string(optional)Current Account Number. Maximum length is 7. Validating pattern is ^[A-Za-z0-9]*$.
- currentAwardNumber
string(optional)Current Award Number. Maximum length is 12. Validating pattern is ^[\p{Graph}]*$.
- deadlineDate
string(optional)The date in which the proposal is due to the sponsoring agency. Additional deadlines may be set by the office authorized to submit proposals on behalf of the institution (e.g. sponsored programs, etc.). Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- deadlineTime
string(optional)The time in which the proposal is due to the sponsoring agency. Additional deadlines may be set by the office authorized to submit proposals on behalf of the institution (e.g. sponsored programs, etc.). Maximum length is 15. Validating pattern is .*.
- deadlineType
string(optional)Indicates the type of proposal deadline. Maximum length is 3. Validating pattern is ^[\p{Graph}]*$.
- fiscalMonth
string(optional)Fiscal Month. Maximum length is 2. Validating pattern is ^[0-9]*$.
- fiscalYear
string(optional)Fiscal Year. Maximum length is 4. Validating pattern is ^[0-9]*$.
- gradStudHeadcount
string(optional)Grad Stud Headcount. Maximum length is 3. Validating pattern is ^[0-9]*$.
- gradStudPersonMonths
string(optional)Grad Stud Person Months. Maximum length is 6. Validating pattern is ^-?([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.
- hpcCoreHours
string(optional)HPC Core Hours. Maximum length is 100. Validating pattern is .*.
- idcRateIndicator
string(optional)This attribute should always be overridden on the descriptive elements. Maximum length is 1. Validating pattern is .*.
- initialContractAdmin
string(optional)Initial Contract Admin. Maximum length is 30. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- ipReviewActivityIndicator
string(optional)Ip Review Activity Indicator. Maximum length is 2. Validating pattern is ^[A-Za-z0-9\s]*$.
- mailAccountNumber
string(optional)The internal school account number that should be charged the mailing costs. Maximum length is 7. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- mailBy
string(optional)This field determines whether the Sponsored Programs Office or the department will be mailing the proposal to the agency/sponsor. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- mailDescription
string(optional)Any information that will assist in the delivery of the proposal. Maximum length is 1000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- mailType
string(optional)The method by which the proposal will be delivered to the agency/sponsor. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- noticeOfOpportunityCode
string(optional)Notice Of Opportunity Code. Maximum length is 3. Validating pattern is ^[\p{Graph}]*$.
- nsfSequenceNumber
string(optional)NSF Science Code. Maximum length is 12. Validating pattern is ^[0-9]*$.
- numberOfCopies
string(optional)The number of paper copies of the proposal that should be mailed to the agency/sponsor. Maximum length is 2. Validating pattern is ^[0-9]*$.
- opportunity
string(optional)Opportunity. Maximum length is 50. Validating pattern is ^[\u0000-\uFFFF]*$.
- primeSponsorCode
string(optional)Prime Sponsor Code. Maximum length is 20. Validating pattern is ^[A-Za-z0-9]*$.
- proposalId
string(optional)Institutional Proposal ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
- proposalNumber
string(optional)Institutional Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- proposalSequenceStatus
string(optional)- proposalTypeCode
string(optional)Proposal Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
- requestedEndDateInitial
string(optional)Requested End Date Initial. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- requestedEndDateTotal
string(optional)Requested End Date Total. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- requestedStartDateInitial
string(optional)Requested Start Date Initial. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- requestedStartDateTotal
string(optional)Requested Start Date Total. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- rolodexId
string(optional)Rolodex ID. Maximum length is 22. Validating pattern is ^((-?[1-9][0-9])|[0])*$.
- scienceCodeIndicator
string(optional)- sequenceNumber
string(optional)Institutional Proposal Version. Maximum length is 22. Validating pattern is ^[0-9]*$.
- specialReviewIndicator
string(optional)This attribute should always be overridden on the descriptive elements. Maximum length is 1. Validating pattern is .*.
- sponsorCode
string(optional)Sponsor ID. Maximum length is 20. Validating pattern is ^[A-Za-z0-9]*$.
- sponsorProposalNumber
string(optional)Sponsor Proposal ID. Maximum length is 70. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- statusCode
string(optional)Status Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
- subcontractFlag
string(optional)Subcontract Flag. Maximum length is 3. Validating pattern is ^[\p{Graph}]*$.
- title
string(optional)Title. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- totalDirectCostInitial
string(optional)Total Direct Cost Initial. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- totalDirectCostTotal
string(optional)Total Direct Cost Total. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- totalIndirectCostInitial
string(optional)Total Indirect Cost Initial. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- totalIndirectCostTotal
string(optional)Total Indirect Cost Total. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- typeOfAccount
string(optional)Type Of Account. Maximum length is 1. Validating pattern is .*.
- unitNumber
string(optional)The lead unit number for the Institutional Proposal. Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"institutionalProposalDocument.documentNumber": "(val)",
"activityTypeCode": "(val)",
"awardTypeCode": "(val)",
"budgetEndDate": "(val)",
"budgetId": "(val)",
"budgetStartDate": "(val)",
"coSponsorRatio": "(val)",
"coSponsorTotal": "(val)",
"costShareTotal": "(val)",
"costSharingIndicator": "(val)",
"createTimestamp": "(val)",
"currentAccountNumber": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"deadlineType": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"gradStudHeadcount": "(val)",
"gradStudPersonMonths": "(val)",
"hpcCoreHours": "(val)",
"idcRateIndicator": "(val)",
"initialContractAdmin": "(val)",
"ipReviewActivityIndicator": "(val)",
"mailAccountNumber": "(val)",
"mailBy": "(val)",
"mailDescription": "(val)",
"mailType": "(val)",
"noticeOfOpportunityCode": "(val)",
"nsfSequenceNumber": "(val)",
"numberOfCopies": "(val)",
"opportunity": "(val)",
"primeSponsorCode": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"proposalSequenceStatus": "(val)",
"proposalTypeCode": "(val)",
"requestedEndDateInitial": "(val)",
"requestedEndDateTotal": "(val)",
"requestedStartDateInitial": "(val)",
"requestedStartDateTotal": "(val)",
"rolodexId": "(val)",
"scienceCodeIndicator": "(val)",
"sequenceNumber": "(val)",
"specialReviewIndicator": "(val)",
"sponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"statusCode": "(val)",
"subcontractFlag": "(val)",
"title": "(val)",
"totalDirectCostInitial": "(val)",
"totalDirectCostTotal": "(val)",
"totalIndirectCostInitial": "(val)",
"totalIndirectCostTotal": "(val)",
"typeOfAccount": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalDocument.documentNumber": "(val)",
"activityTypeCode": "(val)",
"awardTypeCode": "(val)",
"budgetEndDate": "(val)",
"budgetId": "(val)",
"budgetStartDate": "(val)",
"coSponsorRatio": "(val)",
"coSponsorTotal": "(val)",
"costShareTotal": "(val)",
"costSharingIndicator": "(val)",
"createTimestamp": "(val)",
"currentAccountNumber": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"deadlineType": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"gradStudHeadcount": "(val)",
"gradStudPersonMonths": "(val)",
"hpcCoreHours": "(val)",
"idcRateIndicator": "(val)",
"initialContractAdmin": "(val)",
"ipReviewActivityIndicator": "(val)",
"mailAccountNumber": "(val)",
"mailBy": "(val)",
"mailDescription": "(val)",
"mailType": "(val)",
"noticeOfOpportunityCode": "(val)",
"nsfSequenceNumber": "(val)",
"numberOfCopies": "(val)",
"opportunity": "(val)",
"primeSponsorCode": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"proposalSequenceStatus": "(val)",
"proposalTypeCode": "(val)",
"requestedEndDateInitial": "(val)",
"requestedEndDateTotal": "(val)",
"requestedStartDateInitial": "(val)",
"requestedStartDateTotal": "(val)",
"rolodexId": "(val)",
"scienceCodeIndicator": "(val)",
"sequenceNumber": "(val)",
"specialReviewIndicator": "(val)",
"sponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"statusCode": "(val)",
"subcontractFlag": "(val)",
"title": "(val)",
"totalDirectCostInitial": "(val)",
"totalDirectCostTotal": "(val)",
"totalIndirectCostInitial": "(val)",
"totalIndirectCostTotal": "(val)",
"typeOfAccount": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institutional ProposalsGET/instprop/api/v1/institutional-proposals/
Example URI
GET /instprop/api/v1/institutional-proposals/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"institutionalProposalDocument.documentNumber",
"activityTypeCode",
"awardTypeCode",
"budgetEndDate",
"budgetId",
"budgetStartDate",
"coSponsorRatio",
"coSponsorTotal",
"costShareTotal",
"costSharingIndicator",
"createTimestamp",
"currentAccountNumber",
"currentAwardNumber",
"deadlineDate",
"deadlineTime",
"deadlineType",
"fiscalMonth",
"fiscalYear",
"gradStudHeadcount",
"gradStudPersonMonths",
"hpcCoreHours",
"idcRateIndicator",
"initialContractAdmin",
"ipReviewActivityIndicator",
"mailAccountNumber",
"mailBy",
"mailDescription",
"mailType",
"noticeOfOpportunityCode",
"nsfSequenceNumber",
"numberOfCopies",
"opportunity",
"primeSponsorCode",
"proposalId",
"proposalNumber",
"proposalSequenceStatus",
"proposalTypeCode",
"requestedEndDateInitial",
"requestedEndDateTotal",
"requestedStartDateInitial",
"requestedStartDateTotal",
"rolodexId",
"scienceCodeIndicator",
"sequenceNumber",
"specialReviewIndicator",
"sponsorCode",
"sponsorProposalNumber",
"statusCode",
"subcontractFlag",
"title",
"totalDirectCostInitial",
"totalDirectCostTotal",
"totalIndirectCostInitial",
"totalIndirectCostTotal",
"typeOfAccount",
"unitNumber"
],
"primaryKey": "proposalId"
}Get Blueprint API specification for Institutional ProposalsGET/instprop/api/v1/institutional-proposals/
Example URI
GET /instprop/api/v1/institutional-proposals/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposals.md"
transfer-encoding: chunkedUpdate Institutional ProposalsPUT/instprop/api/v1/institutional-proposals/(key)
Example URI
PUT /instprop/api/v1/institutional-proposals/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"institutionalProposalDocument.documentNumber": "(val)",
"activityTypeCode": "(val)",
"awardTypeCode": "(val)",
"budgetEndDate": "(val)",
"budgetId": "(val)",
"budgetStartDate": "(val)",
"coSponsorRatio": "(val)",
"coSponsorTotal": "(val)",
"costShareTotal": "(val)",
"costSharingIndicator": "(val)",
"createTimestamp": "(val)",
"currentAccountNumber": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"deadlineType": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"gradStudHeadcount": "(val)",
"gradStudPersonMonths": "(val)",
"hpcCoreHours": "(val)",
"idcRateIndicator": "(val)",
"initialContractAdmin": "(val)",
"ipReviewActivityIndicator": "(val)",
"mailAccountNumber": "(val)",
"mailBy": "(val)",
"mailDescription": "(val)",
"mailType": "(val)",
"noticeOfOpportunityCode": "(val)",
"nsfSequenceNumber": "(val)",
"numberOfCopies": "(val)",
"opportunity": "(val)",
"primeSponsorCode": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"proposalSequenceStatus": "(val)",
"proposalTypeCode": "(val)",
"requestedEndDateInitial": "(val)",
"requestedEndDateTotal": "(val)",
"requestedStartDateInitial": "(val)",
"requestedStartDateTotal": "(val)",
"rolodexId": "(val)",
"scienceCodeIndicator": "(val)",
"sequenceNumber": "(val)",
"specialReviewIndicator": "(val)",
"sponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"statusCode": "(val)",
"subcontractFlag": "(val)",
"title": "(val)",
"totalDirectCostInitial": "(val)",
"totalDirectCostTotal": "(val)",
"totalIndirectCostInitial": "(val)",
"totalIndirectCostTotal": "(val)",
"typeOfAccount": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Institutional ProposalsPUT/instprop/api/v1/institutional-proposals/
Example URI
PUT /instprop/api/v1/institutional-proposals/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"institutionalProposalDocument.documentNumber": "(val)",
"activityTypeCode": "(val)",
"awardTypeCode": "(val)",
"budgetEndDate": "(val)",
"budgetId": "(val)",
"budgetStartDate": "(val)",
"coSponsorRatio": "(val)",
"coSponsorTotal": "(val)",
"costShareTotal": "(val)",
"costSharingIndicator": "(val)",
"createTimestamp": "(val)",
"currentAccountNumber": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"deadlineType": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"gradStudHeadcount": "(val)",
"gradStudPersonMonths": "(val)",
"hpcCoreHours": "(val)",
"idcRateIndicator": "(val)",
"initialContractAdmin": "(val)",
"ipReviewActivityIndicator": "(val)",
"mailAccountNumber": "(val)",
"mailBy": "(val)",
"mailDescription": "(val)",
"mailType": "(val)",
"noticeOfOpportunityCode": "(val)",
"nsfSequenceNumber": "(val)",
"numberOfCopies": "(val)",
"opportunity": "(val)",
"primeSponsorCode": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"proposalSequenceStatus": "(val)",
"proposalTypeCode": "(val)",
"requestedEndDateInitial": "(val)",
"requestedEndDateTotal": "(val)",
"requestedStartDateInitial": "(val)",
"requestedStartDateTotal": "(val)",
"rolodexId": "(val)",
"scienceCodeIndicator": "(val)",
"sequenceNumber": "(val)",
"specialReviewIndicator": "(val)",
"sponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"statusCode": "(val)",
"subcontractFlag": "(val)",
"title": "(val)",
"totalDirectCostInitial": "(val)",
"totalDirectCostTotal": "(val)",
"totalIndirectCostInitial": "(val)",
"totalIndirectCostTotal": "(val)",
"typeOfAccount": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"institutionalProposalDocument.documentNumber": "(val)",
"activityTypeCode": "(val)",
"awardTypeCode": "(val)",
"budgetEndDate": "(val)",
"budgetId": "(val)",
"budgetStartDate": "(val)",
"coSponsorRatio": "(val)",
"coSponsorTotal": "(val)",
"costShareTotal": "(val)",
"costSharingIndicator": "(val)",
"createTimestamp": "(val)",
"currentAccountNumber": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"deadlineType": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"gradStudHeadcount": "(val)",
"gradStudPersonMonths": "(val)",
"hpcCoreHours": "(val)",
"idcRateIndicator": "(val)",
"initialContractAdmin": "(val)",
"ipReviewActivityIndicator": "(val)",
"mailAccountNumber": "(val)",
"mailBy": "(val)",
"mailDescription": "(val)",
"mailType": "(val)",
"noticeOfOpportunityCode": "(val)",
"nsfSequenceNumber": "(val)",
"numberOfCopies": "(val)",
"opportunity": "(val)",
"primeSponsorCode": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"proposalSequenceStatus": "(val)",
"proposalTypeCode": "(val)",
"requestedEndDateInitial": "(val)",
"requestedEndDateTotal": "(val)",
"requestedStartDateInitial": "(val)",
"requestedStartDateTotal": "(val)",
"rolodexId": "(val)",
"scienceCodeIndicator": "(val)",
"sequenceNumber": "(val)",
"specialReviewIndicator": "(val)",
"sponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"statusCode": "(val)",
"subcontractFlag": "(val)",
"title": "(val)",
"totalDirectCostInitial": "(val)",
"totalDirectCostTotal": "(val)",
"totalIndirectCostInitial": "(val)",
"totalIndirectCostTotal": "(val)",
"typeOfAccount": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Institutional ProposalsPATCH/instprop/api/v1/institutional-proposals/(key)
Example URI
PATCH /instprop/api/v1/institutional-proposals/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"institutionalProposalDocument.documentNumber": "(val)",
"activityTypeCode": "(val)",
"awardTypeCode": "(val)",
"budgetEndDate": "(val)",
"budgetId": "(val)",
"budgetStartDate": "(val)",
"coSponsorRatio": "(val)",
"coSponsorTotal": "(val)",
"costShareTotal": "(val)",
"costSharingIndicator": "(val)",
"createTimestamp": "(val)",
"currentAccountNumber": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"deadlineType": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"gradStudHeadcount": "(val)",
"gradStudPersonMonths": "(val)",
"hpcCoreHours": "(val)",
"idcRateIndicator": "(val)",
"initialContractAdmin": "(val)",
"ipReviewActivityIndicator": "(val)",
"mailAccountNumber": "(val)",
"mailBy": "(val)",
"mailDescription": "(val)",
"mailType": "(val)",
"noticeOfOpportunityCode": "(val)",
"nsfSequenceNumber": "(val)",
"numberOfCopies": "(val)",
"opportunity": "(val)",
"primeSponsorCode": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"proposalSequenceStatus": "(val)",
"proposalTypeCode": "(val)",
"requestedEndDateInitial": "(val)",
"requestedEndDateTotal": "(val)",
"requestedStartDateInitial": "(val)",
"requestedStartDateTotal": "(val)",
"rolodexId": "(val)",
"scienceCodeIndicator": "(val)",
"sequenceNumber": "(val)",
"specialReviewIndicator": "(val)",
"sponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"statusCode": "(val)",
"subcontractFlag": "(val)",
"title": "(val)",
"totalDirectCostInitial": "(val)",
"totalDirectCostTotal": "(val)",
"totalIndirectCostInitial": "(val)",
"totalIndirectCostTotal": "(val)",
"typeOfAccount": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Institutional Proposal ¶
Proposal SummaryGET/instprop/api/v1/institutional-proposals/?summary
Summary of all Institutional Proposals in the system
Example URI
GET /instprop/api/v1/institutional-proposals/?summary
URI Parameters
- summary
boolean(required)Renders the proposals in a summary view instead of the full data from the proposal. Currently the only option and required.
- updatedSince
date(optional) Example: 1452126023000Criteria to restrict the proposals returned to those updated since the date specified. Formatted as milliseconds since epoch.
- limit
number(optional) Example: 50Number of results to return. If not included, all proposals matching the date,if specified, are returned.
- page
number(optional) Example: 8If a numberPerPage is specified this determines what page of the result set will be returned on this request.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"totalFound" : 598,
"count" : 1,
"institutionalProposals" : [
{
"proposalId": 10,
"proposalNumber" : "80070",
"sequenceNumber": 1
"proposalLogProposalNumber": "00000009",
"leadUnit": {
"unitNumber": "000001",
"unitName": "University",
"parentUnitNumber": null,
"organizationId": "000001"
},
"fundingProposals" : [
{
"proposalSequenceNumber": 1,
"awardNumber": "999901-00001",
"awardSequenceNumber": 1,
"awardId": 2238,
"proposalId": 1,
"proposalNumber": "80070"
},
{
"proposalSequenceNumber": 1,
"awardNumber": "999901-00002",
"awardSequenceNumber": 1,
"awardId": 2251,
"proposalId": 1,
"proposalNumber": "80070"
},
{
"proposalSequenceNumber": 1,
"awardNumber": "999901-00003",
"awardSequenceNumber": 1,
"awardId": 2264,
"proposalId": 1,
"proposalNumber": "80070"
}
],
"principalInvestigator" : {
"fullName" : "Inez Chew",
"personId" : "10000000005",
"roleCode" : "PI",
"projectRole" : "Principal Investigator",
"userName" : "chew",
"emailAddress" : "kcnotification@gmail.com"
},
"sponsor" : {
"sponsorCode" : "055075",
"acronym" : null,
"sponsorName" : "Kuali LOC Testing"
}
},
]
}Intellectual Property Review Activities ¶
Get Intellectual Property Review Activities by KeyGET/instprop/api/v1/intellectual-property-review-activities/(key)
Example URI
GET /instprop/api/v1/intellectual-property-review-activities/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Get All Intellectual Property Review ActivitiesGET/instprop/api/v1/intellectual-property-review-activities/
Example URI
GET /instprop/api/v1/intellectual-property-review-activities/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Intellectual Property Review Activities with FilteringGET/instprop/api/v1/intellectual-property-review-activities/
Example URI
GET /instprop/api/v1/intellectual-property-review-activities/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- activityDate
string(optional)Activity Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- activityNumber
string(optional)Activity Number. Maximum length is 3. Validating pattern is ^[0-9]*$.
- comments
string(optional)Comments. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- ipReviewActivityTypeCode
string(optional)IP Review Activity Type Code. Maximum length is 22. Validating pattern is ^[0-9]*$.
- ipReviewId
string(optional)- proposalIpReviewActivityId
string(optional)Proposal Ip Rev Activity Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Intellectual Property Review ActivitiesGET/instprop/api/v1/intellectual-property-review-activities/
Example URI
GET /instprop/api/v1/intellectual-property-review-activities/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"activityDate",
"activityNumber",
"comments",
"ipReviewActivityTypeCode",
"ipReviewId",
"proposalIpReviewActivityId",
"proposalNumber",
"sequenceNumber"
],
"primaryKey": "proposalIpReviewActivityId"
}Get Blueprint API specification for Intellectual Property Review ActivitiesGET/instprop/api/v1/intellectual-property-review-activities/
Example URI
GET /instprop/api/v1/intellectual-property-review-activities/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Intellectual Property Review Activities.md"
transfer-encoding: chunkedUpdate Intellectual Property Review ActivitiesPUT/instprop/api/v1/intellectual-property-review-activities/(key)
Example URI
PUT /instprop/api/v1/intellectual-property-review-activities/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Intellectual Property Review ActivitiesPUT/instprop/api/v1/intellectual-property-review-activities/
Example URI
PUT /instprop/api/v1/intellectual-property-review-activities/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Intellectual Property Review ActivitiesPATCH/instprop/api/v1/intellectual-property-review-activities/(key)
Example URI
PATCH /instprop/api/v1/intellectual-property-review-activities/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Intellectual Property Review ActivitiesPOST/instprop/api/v1/intellectual-property-review-activities/
Example URI
POST /instprop/api/v1/intellectual-property-review-activities/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Intellectual Property Review ActivitiesPOST/instprop/api/v1/intellectual-property-review-activities/
Example URI
POST /instprop/api/v1/intellectual-property-review-activities/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"activityDate": "(val)",
"activityNumber": "(val)",
"comments": "(val)",
"ipReviewActivityTypeCode": "(val)",
"ipReviewId": "(val)",
"proposalIpReviewActivityId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Intellectual Property Review Activities by KeyDELETE/instprop/api/v1/intellectual-property-review-activities/(key)
Example URI
DELETE /instprop/api/v1/intellectual-property-review-activities/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Intellectual Property Review ActivitiesDELETE/instprop/api/v1/intellectual-property-review-activities/
Example URI
DELETE /instprop/api/v1/intellectual-property-review-activities/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Intellectual Property Review Activities with MatchingDELETE/instprop/api/v1/intellectual-property-review-activities/
Example URI
DELETE /instprop/api/v1/intellectual-property-review-activities/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- activityDate
string(optional)Activity Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- activityNumber
string(optional)Activity Number. Maximum length is 3. Validating pattern is ^[0-9]*$.
- comments
string(optional)Comments. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- ipReviewActivityTypeCode
string(optional)IP Review Activity Type Code. Maximum length is 22. Validating pattern is ^[0-9]*$.
- ipReviewId
string(optional)- proposalIpReviewActivityId
string(optional)Proposal Ip Rev Activity Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalIntellectual Property Review Activity Types ¶
Get Intellectual Property Review Activity Types by KeyGET/instprop/api/v1/intellectual-property-review-activity-types/(key)
Example URI
GET /instprop/api/v1/intellectual-property-review-activity-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Intellectual Property Review Activity TypesGET/instprop/api/v1/intellectual-property-review-activity-types/
Example URI
GET /instprop/api/v1/intellectual-property-review-activity-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Intellectual Property Review Activity Types with FilteringGET/instprop/api/v1/intellectual-property-review-activity-types/
Example URI
GET /instprop/api/v1/intellectual-property-review-activity-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- intellectualPropertyReviewActivityTypeCode
string(optional)Intellectual Property Review Activity Type Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Intellectual Property Review Activity TypesGET/instprop/api/v1/intellectual-property-review-activity-types/
Example URI
GET /instprop/api/v1/intellectual-property-review-activity-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"description",
"intellectualPropertyReviewActivityTypeCode"
],
"primaryKey": "intellectualPropertyReviewActivityTypeCode"
}Get Blueprint API specification for Intellectual Property Review Activity TypesGET/instprop/api/v1/intellectual-property-review-activity-types/
Example URI
GET /instprop/api/v1/intellectual-property-review-activity-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Intellectual Property Review Activity Types.md"
transfer-encoding: chunkedUpdate Intellectual Property Review Activity TypesPUT/instprop/api/v1/intellectual-property-review-activity-types/(key)
Example URI
PUT /instprop/api/v1/intellectual-property-review-activity-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Intellectual Property Review Activity TypesPUT/instprop/api/v1/intellectual-property-review-activity-types/
Example URI
PUT /instprop/api/v1/intellectual-property-review-activity-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Intellectual Property Review Activity TypesPATCH/instprop/api/v1/intellectual-property-review-activity-types/(key)
Example URI
PATCH /instprop/api/v1/intellectual-property-review-activity-types/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Intellectual Property Review Activity TypesPOST/instprop/api/v1/intellectual-property-review-activity-types/
Example URI
POST /instprop/api/v1/intellectual-property-review-activity-types/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Intellectual Property Review Activity TypesPOST/instprop/api/v1/intellectual-property-review-activity-types/
Example URI
POST /instprop/api/v1/intellectual-property-review-activity-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewActivityTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Intellectual Property Review Activity Types by KeyDELETE/instprop/api/v1/intellectual-property-review-activity-types/(key)
Example URI
DELETE /instprop/api/v1/intellectual-property-review-activity-types/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Intellectual Property Review Activity TypesDELETE/instprop/api/v1/intellectual-property-review-activity-types/
Example URI
DELETE /instprop/api/v1/intellectual-property-review-activity-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Intellectual Property Review Activity Types with MatchingDELETE/instprop/api/v1/intellectual-property-review-activity-types/
Example URI
DELETE /instprop/api/v1/intellectual-property-review-activity-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- intellectualPropertyReviewActivityTypeCode
string(optional)Intellectual Property Review Activity Type Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalIntellectual Property Review Requirement Types ¶
Get Intellectual Property Review Requirement Types by KeyGET/instprop/api/v1/intellectual-property-review-requirement-types/(key)
Example URI
GET /instprop/api/v1/intellectual-property-review-requirement-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Intellectual Property Review Requirement TypesGET/instprop/api/v1/intellectual-property-review-requirement-types/
Example URI
GET /instprop/api/v1/intellectual-property-review-requirement-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Intellectual Property Review Requirement Types with FilteringGET/instprop/api/v1/intellectual-property-review-requirement-types/
Example URI
GET /instprop/api/v1/intellectual-property-review-requirement-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- intellectualPropertyReviewRequirementTypeCode
string(optional)Intellectual Property Review Requirement Type Code. Maximum length is 3. Validating pattern is ^[\p{Graph}\p{Space}]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Intellectual Property Review Requirement TypesGET/instprop/api/v1/intellectual-property-review-requirement-types/
Example URI
GET /instprop/api/v1/intellectual-property-review-requirement-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"description",
"intellectualPropertyReviewRequirementTypeCode"
],
"primaryKey": "intellectualPropertyReviewRequirementTypeCode"
}Get Blueprint API specification for Intellectual Property Review Requirement TypesGET/instprop/api/v1/intellectual-property-review-requirement-types/
Example URI
GET /instprop/api/v1/intellectual-property-review-requirement-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Intellectual Property Review Requirement Types.md"
transfer-encoding: chunkedUpdate Intellectual Property Review Requirement TypesPUT/instprop/api/v1/intellectual-property-review-requirement-types/(key)
Example URI
PUT /instprop/api/v1/intellectual-property-review-requirement-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Intellectual Property Review Requirement TypesPUT/instprop/api/v1/intellectual-property-review-requirement-types/
Example URI
PUT /instprop/api/v1/intellectual-property-review-requirement-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Intellectual Property Review Requirement TypesPATCH/instprop/api/v1/intellectual-property-review-requirement-types/(key)
Example URI
PATCH /instprop/api/v1/intellectual-property-review-requirement-types/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Intellectual Property Review Requirement TypesPOST/instprop/api/v1/intellectual-property-review-requirement-types/
Example URI
POST /instprop/api/v1/intellectual-property-review-requirement-types/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Intellectual Property Review Requirement TypesPOST/instprop/api/v1/intellectual-property-review-requirement-types/
Example URI
POST /instprop/api/v1/intellectual-property-review-requirement-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewRequirementTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Intellectual Property Review Requirement Types by KeyDELETE/instprop/api/v1/intellectual-property-review-requirement-types/(key)
Example URI
DELETE /instprop/api/v1/intellectual-property-review-requirement-types/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Intellectual Property Review Requirement TypesDELETE/instprop/api/v1/intellectual-property-review-requirement-types/
Example URI
DELETE /instprop/api/v1/intellectual-property-review-requirement-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Intellectual Property Review Requirement Types with MatchingDELETE/instprop/api/v1/intellectual-property-review-requirement-types/
Example URI
DELETE /instprop/api/v1/intellectual-property-review-requirement-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- intellectualPropertyReviewRequirementTypeCode
string(optional)Intellectual Property Review Requirement Type Code. Maximum length is 3. Validating pattern is ^[\p{Graph}\p{Space}]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalIntellectual Property Review Result Types ¶
Get Intellectual Property Review Result Types by KeyGET/instprop/api/v1/intellectual-property-review-result-types/(key)
Example URI
GET /instprop/api/v1/intellectual-property-review-result-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Intellectual Property Review Result TypesGET/instprop/api/v1/intellectual-property-review-result-types/
Example URI
GET /instprop/api/v1/intellectual-property-review-result-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Intellectual Property Review Result Types with FilteringGET/instprop/api/v1/intellectual-property-review-result-types/
Example URI
GET /instprop/api/v1/intellectual-property-review-result-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- intellectualPropertyReviewResultTypeCode
string(optional)Intellectual Property Review Result Type Code. Maximum length is 3. Validating pattern is ^[\p{Graph}\p{Space}]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Intellectual Property Review Result TypesGET/instprop/api/v1/intellectual-property-review-result-types/
Example URI
GET /instprop/api/v1/intellectual-property-review-result-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"description",
"intellectualPropertyReviewResultTypeCode"
],
"primaryKey": "intellectualPropertyReviewResultTypeCode"
}Get Blueprint API specification for Intellectual Property Review Result TypesGET/instprop/api/v1/intellectual-property-review-result-types/
Example URI
GET /instprop/api/v1/intellectual-property-review-result-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Intellectual Property Review Result Types.md"
transfer-encoding: chunkedUpdate Intellectual Property Review Result TypesPUT/instprop/api/v1/intellectual-property-review-result-types/(key)
Example URI
PUT /instprop/api/v1/intellectual-property-review-result-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Intellectual Property Review Result TypesPUT/instprop/api/v1/intellectual-property-review-result-types/
Example URI
PUT /instprop/api/v1/intellectual-property-review-result-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Intellectual Property Review Result TypesPATCH/instprop/api/v1/intellectual-property-review-result-types/(key)
Example URI
PATCH /instprop/api/v1/intellectual-property-review-result-types/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Intellectual Property Review Result TypesPOST/instprop/api/v1/intellectual-property-review-result-types/
Example URI
POST /instprop/api/v1/intellectual-property-review-result-types/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Intellectual Property Review Result TypesPOST/instprop/api/v1/intellectual-property-review-result-types/
Example URI
POST /instprop/api/v1/intellectual-property-review-result-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"intellectualPropertyReviewResultTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Intellectual Property Review Result Types by KeyDELETE/instprop/api/v1/intellectual-property-review-result-types/(key)
Example URI
DELETE /instprop/api/v1/intellectual-property-review-result-types/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Intellectual Property Review Result TypesDELETE/instprop/api/v1/intellectual-property-review-result-types/
Example URI
DELETE /instprop/api/v1/intellectual-property-review-result-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Intellectual Property Review Result Types with MatchingDELETE/instprop/api/v1/intellectual-property-review-result-types/
Example URI
DELETE /instprop/api/v1/intellectual-property-review-result-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- intellectualPropertyReviewResultTypeCode
string(optional)Intellectual Property Review Result Type Code. Maximum length is 3. Validating pattern is ^[\p{Graph}\p{Space}]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalIntellectual Property Reviews ¶
Get Intellectual Property Reviews by KeyGET/instprop/api/v1/intellectual-property-reviews/(key)
Example URI
GET /instprop/api/v1/intellectual-property-reviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Get All Intellectual Property ReviewsGET/instprop/api/v1/intellectual-property-reviews/
Example URI
GET /instprop/api/v1/intellectual-property-reviews/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Intellectual Property Reviews with FilteringGET/instprop/api/v1/intellectual-property-reviews/
Example URI
GET /instprop/api/v1/intellectual-property-reviews/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- ipReviewId
string(optional)- ipReviewRequirementTypeCode
string(optional)Review Requirement. Maximum length is 22. Validating pattern is ^[0-9]*$.
- ipReviewSequenceStatus
string(optional)- ipReviewer
string(optional)KcPerson Id. Maximum length is 40. Validating pattern is ^[\p{Graph}]*$.
- proposalNumber
string(optional)Institutional Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- reviewReceiveDate
string(optional)Date Finished Review. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- reviewResultCode
string(optional)Review Results. Maximum length is 22. Validating pattern is ^[0-9]*$.
- reviewSubmissionDate
string(optional)Submitted for Review. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- sequenceNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Intellectual Property ReviewsGET/instprop/api/v1/intellectual-property-reviews/
Example URI
GET /instprop/api/v1/intellectual-property-reviews/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"ipReviewId",
"ipReviewRequirementTypeCode",
"ipReviewSequenceStatus",
"ipReviewer",
"proposalNumber",
"reviewReceiveDate",
"reviewResultCode",
"reviewSubmissionDate",
"sequenceNumber"
],
"primaryKey": "ipReviewId"
}Get Blueprint API specification for Intellectual Property ReviewsGET/instprop/api/v1/intellectual-property-reviews/
Example URI
GET /instprop/api/v1/intellectual-property-reviews/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Intellectual Property Reviews.md"
transfer-encoding: chunkedUpdate Intellectual Property ReviewsPUT/instprop/api/v1/intellectual-property-reviews/(key)
Example URI
PUT /instprop/api/v1/intellectual-property-reviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Intellectual Property ReviewsPUT/instprop/api/v1/intellectual-property-reviews/
Example URI
PUT /instprop/api/v1/intellectual-property-reviews/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Intellectual Property ReviewsPATCH/instprop/api/v1/intellectual-property-reviews/(key)
Example URI
PATCH /instprop/api/v1/intellectual-property-reviews/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Intellectual Property ReviewsPOST/instprop/api/v1/intellectual-property-reviews/
Example URI
POST /instprop/api/v1/intellectual-property-reviews/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Intellectual Property ReviewsPOST/instprop/api/v1/intellectual-property-reviews/
Example URI
POST /instprop/api/v1/intellectual-property-reviews/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"ipReviewId": "(val)",
"ipReviewRequirementTypeCode": "(val)",
"ipReviewSequenceStatus": "(val)",
"ipReviewer": "(val)",
"proposalNumber": "(val)",
"reviewReceiveDate": "(val)",
"reviewResultCode": "(val)",
"reviewSubmissionDate": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Intellectual Property Reviews by KeyDELETE/instprop/api/v1/intellectual-property-reviews/(key)
Example URI
DELETE /instprop/api/v1/intellectual-property-reviews/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Intellectual Property ReviewsDELETE/instprop/api/v1/intellectual-property-reviews/
Example URI
DELETE /instprop/api/v1/intellectual-property-reviews/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Intellectual Property Reviews with MatchingDELETE/instprop/api/v1/intellectual-property-reviews/
Example URI
DELETE /instprop/api/v1/intellectual-property-reviews/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- ipReviewId
string(optional)- ipReviewRequirementTypeCode
string(optional)Review Requirement. Maximum length is 22. Validating pattern is ^[0-9]*$.
- ipReviewSequenceStatus
string(optional)- ipReviewer
string(optional)KcPerson Id. Maximum length is 40. Validating pattern is ^[\p{Graph}]*$.
- proposalNumber
string(optional)Institutional Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- reviewReceiveDate
string(optional)Date Finished Review. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- reviewResultCode
string(optional)Review Results. Maximum length is 22. Validating pattern is ^[0-9]*$.
- reviewSubmissionDate
string(optional)Submitted for Review. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- sequenceNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalProposal Admin Details ¶
Get Proposal Admin Details by KeyGET/instprop/api/v1/proposal-admin-details/(key)
Example URI
GET /instprop/api/v1/proposal-admin-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Admin DetailsGET/instprop/api/v1/proposal-admin-details/
Example URI
GET /instprop/api/v1/proposal-admin-details/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
},
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Admin Details with FilteringGET/instprop/api/v1/proposal-admin-details/
Example URI
GET /instprop/api/v1/proposal-admin-details/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- dateApprovedByOsp
string(optional)- dateReturnedToDept
string(optional)- dateSubmittedByDept
string(optional)- dateSubmittedToAgency
string(optional)- devProposalNumber
string(optional)- instPropCreateDate
string(optional)- instPropCreateUser
string(optional)- instProposalId
string(optional)- proposalAdminDetailId
string(optional)- signedBy
string(optional)- submissionType
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
},
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Admin DetailsGET/instprop/api/v1/proposal-admin-details/
Example URI
GET /instprop/api/v1/proposal-admin-details/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"dateApprovedByOsp",
"dateReturnedToDept",
"dateSubmittedByDept",
"dateSubmittedToAgency",
"devProposalNumber",
"instPropCreateDate",
"instPropCreateUser",
"instProposalId",
"proposalAdminDetailId",
"signedBy",
"submissionType"
],
"primaryKey": "proposalAdminDetailId"
}Get Blueprint API specification for Proposal Admin DetailsGET/instprop/api/v1/proposal-admin-details/
Example URI
GET /instprop/api/v1/proposal-admin-details/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Admin Details.md"
transfer-encoding: chunkedUpdate Proposal Admin DetailsPUT/instprop/api/v1/proposal-admin-details/(key)
Example URI
PUT /instprop/api/v1/proposal-admin-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Admin DetailsPUT/instprop/api/v1/proposal-admin-details/
Example URI
PUT /instprop/api/v1/proposal-admin-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
},
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Admin DetailsPATCH/instprop/api/v1/proposal-admin-details/(key)
Example URI
PATCH /instprop/api/v1/proposal-admin-details/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Admin DetailsPOST/instprop/api/v1/proposal-admin-details/
Example URI
POST /instprop/api/v1/proposal-admin-details/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Admin DetailsPOST/instprop/api/v1/proposal-admin-details/
Example URI
POST /instprop/api/v1/proposal-admin-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
},
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
},
{
"dateApprovedByOsp": "(val)",
"dateReturnedToDept": "(val)",
"dateSubmittedByDept": "(val)",
"dateSubmittedToAgency": "(val)",
"devProposalNumber": "(val)",
"instPropCreateDate": "(val)",
"instPropCreateUser": "(val)",
"instProposalId": "(val)",
"proposalAdminDetailId": "(val)",
"signedBy": "(val)",
"submissionType": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Admin Details by KeyDELETE/instprop/api/v1/proposal-admin-details/(key)
Example URI
DELETE /instprop/api/v1/proposal-admin-details/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Admin DetailsDELETE/instprop/api/v1/proposal-admin-details/
Example URI
DELETE /instprop/api/v1/proposal-admin-details/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Proposal Admin Details with MatchingDELETE/instprop/api/v1/proposal-admin-details/
Example URI
DELETE /instprop/api/v1/proposal-admin-details/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- dateApprovedByOsp
string(optional)- dateReturnedToDept
string(optional)- dateSubmittedByDept
string(optional)- dateSubmittedToAgency
string(optional)- devProposalNumber
string(optional)- instPropCreateDate
string(optional)- instPropCreateUser
string(optional)- instProposalId
string(optional)- proposalAdminDetailId
string(optional)- signedBy
string(optional)- submissionType
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalProposal Comments ¶
Get Proposal Comments by KeyGET/instprop/api/v1/proposal-comments/(key)
Example URI
GET /instprop/api/v1/proposal-comments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Get All Proposal CommentsGET/instprop/api/v1/proposal-comments/
Example URI
GET /instprop/api/v1/proposal-comments/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Comments with FilteringGET/instprop/api/v1/proposal-comments/
Example URI
GET /instprop/api/v1/proposal-comments/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- commentTypeCode
string(optional)- comments
string(optional)- proposalCommentsId
string(optional)- proposalId
string(optional)- proposalNumber
string(optional)- sequenceNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal CommentsGET/instprop/api/v1/proposal-comments/
Example URI
GET /instprop/api/v1/proposal-comments/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"commentTypeCode",
"comments",
"proposalCommentsId",
"proposalId",
"proposalNumber",
"sequenceNumber"
],
"primaryKey": "proposalCommentsId"
}Get Blueprint API specification for Proposal CommentsGET/instprop/api/v1/proposal-comments/
Example URI
GET /instprop/api/v1/proposal-comments/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Comments.md"
transfer-encoding: chunkedUpdate Proposal CommentsPUT/instprop/api/v1/proposal-comments/(key)
Example URI
PUT /instprop/api/v1/proposal-comments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal CommentsPUT/instprop/api/v1/proposal-comments/
Example URI
PUT /instprop/api/v1/proposal-comments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal CommentsPATCH/instprop/api/v1/proposal-comments/(key)
Example URI
PATCH /instprop/api/v1/proposal-comments/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Proposal CommentsPOST/instprop/api/v1/proposal-comments/
Example URI
POST /instprop/api/v1/proposal-comments/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal CommentsPOST/instprop/api/v1/proposal-comments/
Example URI
POST /instprop/api/v1/proposal-comments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"comments": "(val)",
"proposalCommentsId": "(val)",
"proposalId": "(val)",
"proposalNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Comments by KeyDELETE/instprop/api/v1/proposal-comments/(key)
Example URI
DELETE /instprop/api/v1/proposal-comments/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal CommentsDELETE/instprop/api/v1/proposal-comments/
Example URI
DELETE /instprop/api/v1/proposal-comments/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Proposal Comments with MatchingDELETE/instprop/api/v1/proposal-comments/
Example URI
DELETE /instprop/api/v1/proposal-comments/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- commentTypeCode
string(optional)- comments
string(optional)- proposalCommentsId
string(optional)- proposalId
string(optional)- proposalNumber
string(optional)- sequenceNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalProposal Intellectual Property Review Joins ¶
Get Proposal Intellectual Property Review Joins by KeyGET/instprop/api/v1/proposal-intellectual-property-review-joins/(key)
Example URI
GET /instprop/api/v1/proposal-intellectual-property-review-joins/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Intellectual Property Review JoinsGET/instprop/api/v1/proposal-intellectual-property-review-joins/
Example URI
GET /instprop/api/v1/proposal-intellectual-property-review-joins/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
},
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Intellectual Property Review Joins with FilteringGET/instprop/api/v1/proposal-intellectual-property-review-joins/
Example URI
GET /instprop/api/v1/proposal-intellectual-property-review-joins/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- ipReviewId
string(optional)- proposalId
string(optional)- proposalIpReviewJoinId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
},
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Intellectual Property Review JoinsGET/instprop/api/v1/proposal-intellectual-property-review-joins/
Example URI
GET /instprop/api/v1/proposal-intellectual-property-review-joins/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"ipReviewId",
"proposalId",
"proposalIpReviewJoinId"
],
"primaryKey": "proposalIpReviewJoinId"
}Get Blueprint API specification for Proposal Intellectual Property Review JoinsGET/instprop/api/v1/proposal-intellectual-property-review-joins/
Example URI
GET /instprop/api/v1/proposal-intellectual-property-review-joins/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Intellectual Property Review Joins.md"
transfer-encoding: chunkedUpdate Proposal Intellectual Property Review JoinsPUT/instprop/api/v1/proposal-intellectual-property-review-joins/(key)
Example URI
PUT /instprop/api/v1/proposal-intellectual-property-review-joins/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Intellectual Property Review JoinsPUT/instprop/api/v1/proposal-intellectual-property-review-joins/
Example URI
PUT /instprop/api/v1/proposal-intellectual-property-review-joins/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
},
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Intellectual Property Review JoinsPATCH/instprop/api/v1/proposal-intellectual-property-review-joins/(key)
Example URI
PATCH /instprop/api/v1/proposal-intellectual-property-review-joins/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Intellectual Property Review JoinsPOST/instprop/api/v1/proposal-intellectual-property-review-joins/
Example URI
POST /instprop/api/v1/proposal-intellectual-property-review-joins/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Intellectual Property Review JoinsPOST/instprop/api/v1/proposal-intellectual-property-review-joins/
Example URI
POST /instprop/api/v1/proposal-intellectual-property-review-joins/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
},
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
},
{
"ipReviewId": "(val)",
"proposalId": "(val)",
"proposalIpReviewJoinId": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Intellectual Property Review Joins by KeyDELETE/instprop/api/v1/proposal-intellectual-property-review-joins/(key)
Example URI
DELETE /instprop/api/v1/proposal-intellectual-property-review-joins/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Intellectual Property Review JoinsDELETE/instprop/api/v1/proposal-intellectual-property-review-joins/
Example URI
DELETE /instprop/api/v1/proposal-intellectual-property-review-joins/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Proposal Intellectual Property Review Joins with MatchingDELETE/instprop/api/v1/proposal-intellectual-property-review-joins/
Example URI
DELETE /instprop/api/v1/proposal-intellectual-property-review-joins/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- ipReviewId
string(optional)- proposalId
string(optional)- proposalIpReviewJoinId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalProposal Log Person Mass Changes ¶
Get Proposal Log Person Mass Changes by KeyGET/instprop/api/v1/proposal-log-person-mass-changes/(key)
Example URI
GET /instprop/api/v1/proposal-log-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Log Person Mass ChangesGET/instprop/api/v1/proposal-log-person-mass-changes/
Example URI
GET /instprop/api/v1/proposal-log-person-mass-changes/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
},
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Log Person Mass Changes with FilteringGET/instprop/api/v1/proposal-log-person-mass-changes/
Example URI
GET /instprop/api/v1/proposal-log-person-mass-changes/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- personMassChangeId
string(optional)Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.
- principalInvestigator
string(optional)Principal Investigator. Maximum length is 1. Validating pattern is .*.
- proposalLogPersonMassChangeId
string(optional)Proposal Log Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
},
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Log Person Mass ChangesGET/instprop/api/v1/proposal-log-person-mass-changes/
Example URI
GET /instprop/api/v1/proposal-log-person-mass-changes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"personMassChangeId",
"principalInvestigator",
"proposalLogPersonMassChangeId"
],
"primaryKey": "proposalLogPersonMassChangeId"
}Get Blueprint API specification for Proposal Log Person Mass ChangesGET/instprop/api/v1/proposal-log-person-mass-changes/
Example URI
GET /instprop/api/v1/proposal-log-person-mass-changes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Log Person Mass Changes.md"
transfer-encoding: chunkedUpdate Proposal Log Person Mass ChangesPUT/instprop/api/v1/proposal-log-person-mass-changes/(key)
Example URI
PUT /instprop/api/v1/proposal-log-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Log Person Mass ChangesPUT/instprop/api/v1/proposal-log-person-mass-changes/
Example URI
PUT /instprop/api/v1/proposal-log-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
},
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Log Person Mass ChangesPATCH/instprop/api/v1/proposal-log-person-mass-changes/(key)
Example URI
PATCH /instprop/api/v1/proposal-log-person-mass-changes/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Log Person Mass ChangesPOST/instprop/api/v1/proposal-log-person-mass-changes/
Example URI
POST /instprop/api/v1/proposal-log-person-mass-changes/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Log Person Mass ChangesPOST/instprop/api/v1/proposal-log-person-mass-changes/
Example URI
POST /instprop/api/v1/proposal-log-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
},
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
},
{
"personMassChangeId": "(val)",
"principalInvestigator": "(val)",
"proposalLogPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Log Person Mass Changes by KeyDELETE/instprop/api/v1/proposal-log-person-mass-changes/(key)
Example URI
DELETE /instprop/api/v1/proposal-log-person-mass-changes/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Log Person Mass ChangesDELETE/instprop/api/v1/proposal-log-person-mass-changes/
Example URI
DELETE /instprop/api/v1/proposal-log-person-mass-changes/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Proposal Log Person Mass Changes with MatchingDELETE/instprop/api/v1/proposal-log-person-mass-changes/
Example URI
DELETE /instprop/api/v1/proposal-log-person-mass-changes/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- personMassChangeId
string(optional)Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.
- principalInvestigator
string(optional)Principal Investigator. Maximum length is 1. Validating pattern is .*.
- proposalLogPersonMassChangeId
string(optional)Proposal Log Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalProposal Log Statuses ¶
Get Proposal Log Statuses by KeyGET/instprop/api/v1/proposal-log-statuses/(key)
Example URI
GET /instprop/api/v1/proposal-log-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Log StatusesGET/instprop/api/v1/proposal-log-statuses/
Example URI
GET /instprop/api/v1/proposal-log-statuses/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Log Statuses with FilteringGET/instprop/api/v1/proposal-log-statuses/
Example URI
GET /instprop/api/v1/proposal-log-statuses/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[A-Za-z0-9]*$.
- proposalLogStatusCode
string(optional)Proposal Log Status Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Log StatusesGET/instprop/api/v1/proposal-log-statuses/
Example URI
GET /instprop/api/v1/proposal-log-statuses/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"description",
"proposalLogStatusCode"
],
"primaryKey": "proposalLogStatusCode"
}Get Blueprint API specification for Proposal Log StatusesGET/instprop/api/v1/proposal-log-statuses/
Example URI
GET /instprop/api/v1/proposal-log-statuses/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Log Statuses.md"
transfer-encoding: chunkedUpdate Proposal Log StatusesPUT/instprop/api/v1/proposal-log-statuses/(key)
Example URI
PUT /instprop/api/v1/proposal-log-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Log StatusesPUT/instprop/api/v1/proposal-log-statuses/
Example URI
PUT /instprop/api/v1/proposal-log-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Log StatusesPATCH/instprop/api/v1/proposal-log-statuses/(key)
Example URI
PATCH /instprop/api/v1/proposal-log-statuses/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Log StatusesPOST/instprop/api/v1/proposal-log-statuses/
Example URI
POST /instprop/api/v1/proposal-log-statuses/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Log StatusesPOST/instprop/api/v1/proposal-log-statuses/
Example URI
POST /instprop/api/v1/proposal-log-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalLogStatusCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Log Statuses by KeyDELETE/instprop/api/v1/proposal-log-statuses/(key)
Example URI
DELETE /instprop/api/v1/proposal-log-statuses/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Log StatusesDELETE/instprop/api/v1/proposal-log-statuses/
Example URI
DELETE /instprop/api/v1/proposal-log-statuses/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Proposal Log Statuses with MatchingDELETE/instprop/api/v1/proposal-log-statuses/
Example URI
DELETE /instprop/api/v1/proposal-log-statuses/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[A-Za-z0-9]*$.
- proposalLogStatusCode
string(optional)Proposal Log Status Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalProposal Log Types ¶
Get Proposal Log Types by KeyGET/instprop/api/v1/proposal-log-types/(key)
Example URI
GET /instprop/api/v1/proposal-log-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Log TypesGET/instprop/api/v1/proposal-log-types/
Example URI
GET /instprop/api/v1/proposal-log-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Log Types with FilteringGET/instprop/api/v1/proposal-log-types/
Example URI
GET /instprop/api/v1/proposal-log-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[A-Za-z0-9]*$.
- proposalLogTypeCode
string(optional)Proposal Log Type Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Log TypesGET/instprop/api/v1/proposal-log-types/
Example URI
GET /instprop/api/v1/proposal-log-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"description",
"proposalLogTypeCode"
],
"primaryKey": "proposalLogTypeCode"
}Get Blueprint API specification for Proposal Log TypesGET/instprop/api/v1/proposal-log-types/
Example URI
GET /instprop/api/v1/proposal-log-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Log Types.md"
transfer-encoding: chunkedUpdate Proposal Log TypesPUT/instprop/api/v1/proposal-log-types/(key)
Example URI
PUT /instprop/api/v1/proposal-log-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Log TypesPUT/instprop/api/v1/proposal-log-types/
Example URI
PUT /instprop/api/v1/proposal-log-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Log TypesPATCH/instprop/api/v1/proposal-log-types/(key)
Example URI
PATCH /instprop/api/v1/proposal-log-types/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Log TypesPOST/instprop/api/v1/proposal-log-types/
Example URI
POST /instprop/api/v1/proposal-log-types/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Log TypesPOST/instprop/api/v1/proposal-log-types/
Example URI
POST /instprop/api/v1/proposal-log-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalLogTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Log Types by KeyDELETE/instprop/api/v1/proposal-log-types/(key)
Example URI
DELETE /instprop/api/v1/proposal-log-types/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Log TypesDELETE/instprop/api/v1/proposal-log-types/
Example URI
DELETE /instprop/api/v1/proposal-log-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Proposal Log Types with MatchingDELETE/instprop/api/v1/proposal-log-types/
Example URI
DELETE /instprop/api/v1/proposal-log-types/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[A-Za-z0-9]*$.
- proposalLogTypeCode
string(optional)Proposal Log Type Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalProposal Logs ¶
Get Proposal Logs by KeyGET/instprop/api/v1/proposal-logs/(key)
Example URI
GET /instprop/api/v1/proposal-logs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Get All Proposal LogsGET/instprop/api/v1/proposal-logs/
Example URI
GET /instprop/api/v1/proposal-logs/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Logs with FilteringGET/instprop/api/v1/proposal-logs/
Example URI
GET /instprop/api/v1/proposal-logs/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- comments
string(optional)Comments. Maximum length is 300. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- createTimestamp
string(optional)Log Create Date. Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- createUser
string(optional)The user who created the object. Maximum length is 60. Validating pattern is ^[\p{Graph}]*$.
- deadlineDate
string(optional)Deadline Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- deadlineTime
string(optional)The time in which the proposal is due to the sponsoring agency. Additional deadlines may be set by the office authorized to submit proposals on behalf of the institution (e.g. sponsored programs, etc.). Maximum length is 15. Validating pattern is .*.
- fiscalMonth
string(optional)Fiscal Month. Maximum length is 2. Validating pattern is ^[0-9]*$.
- fiscalYear
string(optional)Fiscal Year. Maximum length is 4. Validating pattern is ^[A-Za-z0-9]*$.
- instProposalNumber
string(optional)Created Institutional Proposal. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- leadUnit
string(optional)Lead Unit. Maximum length is 20. Validating pattern is ^[\p{Graph}]*$.
- logStatus
string(optional)Log Status. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- mergedWith
string(optional)Proposal Merged With. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- piId
string(optional)KcPerson Id. Maximum length is 40. Validating pattern is ^[\p{Graph}]*$.
- piName
string(optional)Principal Investigator. Maximum length is 165. Validating pattern is .*.
- proposalLogTypeCode
string(optional)Proposal Log Type Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- proposalTypeCode
string(optional)Proposal Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
- rolodexId
string(optional)Rolodex Id. Maximum length is 6. Validating pattern is ^((-?[1-9][0-9])|[0])*$.
- sponsorCode
string(optional)Sponsor. Maximum length is 20. Validating pattern is ^[A-Za-z0-9]*$.
- sponsorName
string(optional)Sponsor Name. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- title
string(optional)Title. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal LogsGET/instprop/api/v1/proposal-logs/
Example URI
GET /instprop/api/v1/proposal-logs/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"comments",
"createTimestamp",
"createUser",
"deadlineDate",
"deadlineTime",
"fiscalMonth",
"fiscalYear",
"instProposalNumber",
"leadUnit",
"logStatus",
"mergedWith",
"piId",
"piName",
"proposalLogTypeCode",
"proposalNumber",
"proposalTypeCode",
"rolodexId",
"sponsorCode",
"sponsorName",
"title"
],
"primaryKey": "proposalNumber"
}Get Blueprint API specification for Proposal LogsGET/instprop/api/v1/proposal-logs/
Example URI
GET /instprop/api/v1/proposal-logs/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Logs.md"
transfer-encoding: chunkedUpdate Proposal LogsPUT/instprop/api/v1/proposal-logs/(key)
Example URI
PUT /instprop/api/v1/proposal-logs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal LogsPUT/instprop/api/v1/proposal-logs/
Example URI
PUT /instprop/api/v1/proposal-logs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal LogsPATCH/instprop/api/v1/proposal-logs/(key)
Example URI
PATCH /instprop/api/v1/proposal-logs/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Insert Proposal LogsPOST/instprop/api/v1/proposal-logs/
Example URI
POST /instprop/api/v1/proposal-logs/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal LogsPOST/instprop/api/v1/proposal-logs/
Example URI
POST /instprop/api/v1/proposal-logs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"comments": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"fiscalMonth": "(val)",
"fiscalYear": "(val)",
"instProposalNumber": "(val)",
"leadUnit": "(val)",
"logStatus": "(val)",
"mergedWith": "(val)",
"piId": "(val)",
"piName": "(val)",
"proposalLogTypeCode": "(val)",
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"rolodexId": "(val)",
"sponsorCode": "(val)",
"sponsorName": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Logs by KeyDELETE/instprop/api/v1/proposal-logs/(key)
Example URI
DELETE /instprop/api/v1/proposal-logs/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal LogsDELETE/instprop/api/v1/proposal-logs/
Example URI
DELETE /instprop/api/v1/proposal-logs/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Proposal Logs with MatchingDELETE/instprop/api/v1/proposal-logs/
Example URI
DELETE /instprop/api/v1/proposal-logs/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- comments
string(optional)Comments. Maximum length is 300. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- createTimestamp
string(optional)Log Create Date. Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- createUser
string(optional)The user who created the object. Maximum length is 60. Validating pattern is ^[\p{Graph}]*$.
- deadlineDate
string(optional)Deadline Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- deadlineTime
string(optional)The time in which the proposal is due to the sponsoring agency. Additional deadlines may be set by the office authorized to submit proposals on behalf of the institution (e.g. sponsored programs, etc.). Maximum length is 15. Validating pattern is .*.
- fiscalMonth
string(optional)Fiscal Month. Maximum length is 2. Validating pattern is ^[0-9]*$.
- fiscalYear
string(optional)Fiscal Year. Maximum length is 4. Validating pattern is ^[A-Za-z0-9]*$.
- instProposalNumber
string(optional)Created Institutional Proposal. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- leadUnit
string(optional)Lead Unit. Maximum length is 20. Validating pattern is ^[\p{Graph}]*$.
- logStatus
string(optional)Log Status. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- mergedWith
string(optional)Proposal Merged With. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- piId
string(optional)KcPerson Id. Maximum length is 40. Validating pattern is ^[\p{Graph}]*$.
- piName
string(optional)Principal Investigator. Maximum length is 165. Validating pattern is .*.
- proposalLogTypeCode
string(optional)Proposal Log Type Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.
- proposalTypeCode
string(optional)Proposal Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
- rolodexId
string(optional)Rolodex Id. Maximum length is 6. Validating pattern is ^((-?[1-9][0-9])|[0])*$.
- sponsorCode
string(optional)Sponsor. Maximum length is 20. Validating pattern is ^[A-Za-z0-9]*$.
- sponsorName
string(optional)Sponsor Name. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- title
string(optional)Title. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalProposal Statuses ¶
Get Proposal Statuses by KeyGET/instprop/api/v1/proposal-statuses/(key)
Example URI
GET /instprop/api/v1/proposal-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
}Get All Proposal StatusesGET/instprop/api/v1/proposal-statuses/
Example URI
GET /instprop/api/v1/proposal-statuses/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Statuses with FilteringGET/instprop/api/v1/proposal-statuses/
Example URI
GET /instprop/api/v1/proposal-statuses/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to fetch. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- proposalStatusCode
string(optional)Proposal Status Code. Maximum length is 22. Validating pattern is ^[0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to fetch either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalBody
[
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal StatusesGET/instprop/api/v1/proposal-statuses/
Example URI
GET /instprop/api/v1/proposal-statuses/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"description",
"proposalStatusCode"
],
"primaryKey": "proposalStatusCode"
}Get Blueprint API specification for Proposal StatusesGET/instprop/api/v1/proposal-statuses/
Example URI
GET /instprop/api/v1/proposal-statuses/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Statuses.md"
transfer-encoding: chunkedUpdate Proposal StatusesPUT/instprop/api/v1/proposal-statuses/(key)
Example URI
PUT /instprop/api/v1/proposal-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal StatusesPUT/instprop/api/v1/proposal-statuses/
Example URI
PUT /instprop/api/v1/proposal-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal StatusesPATCH/instprop/api/v1/proposal-statuses/(key)
Example URI
PATCH /instprop/api/v1/proposal-statuses/(key)
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Body
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
}Insert Proposal StatusesPOST/instprop/api/v1/proposal-statuses/
Example URI
POST /instprop/api/v1/proposal-statuses/
URI Parameters
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
201Body
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal StatusesPOST/instprop/api/v1/proposal-statuses/
Example URI
POST /instprop/api/v1/proposal-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"proposalStatusCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Statuses by KeyDELETE/instprop/api/v1/proposal-statuses/(key)
Example URI
DELETE /instprop/api/v1/proposal-statuses/(key)
URI Parameters
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal StatusesDELETE/instprop/api/v1/proposal-statuses/
Example URI
DELETE /instprop/api/v1/proposal-statuses/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in totalDelete All Proposal Statuses with MatchingDELETE/instprop/api/v1/proposal-statuses/
Example URI
DELETE /instprop/api/v1/proposal-statuses/
URI Parameters
- _startIndex
string(optional)The integer index to use for paging. Zero based. If not present, defaults to 0. Cannot be less than 0.
- _limit
string(optional)The integer number of records to delete. If not present, defaults to a system defined value. Cannot be greater than the system defined value.
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- proposalStatusCode
string(optional)Proposal Status Code. Maximum length is 22. Validating pattern is ^[0-9]*$.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Headers
X-Kuali-Paging-Start-Index: startIndex - The integer index used for paging.
X-Kuali-Paging-Limit: limit - The integer number of records used to delete either imposed by the system or as requested
X-Kuali-Paging-Total: total - The integer number of records in total