API Documentation
Kuali Research REST APIs - Subaward
Research Subaward ¶
Closeout Types ¶
Get Closeout Types by KeyGET/subaward/api/v1/closeout-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Closeout TypesGET/subaward/api/v1/closeout-types/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Closeout Types with FilteringGET/subaward/api/v1/closeout-types/
Example URI
- _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.
- closeoutTypeCode
string(optional)Closeout Type. Maximum length is 22. Validating pattern is ^[0-9]*$.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\u0000-\uFFFF]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Closeout TypesGET/subaward/api/v1/closeout-types/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"closeoutTypeCode",
"description"
],
"primaryKey": "closeoutTypeCode"
}Get Blueprint API specification for Closeout TypesGET/subaward/api/v1/closeout-types/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Closeout Types.md"
transfer-encoding: chunkedUpdate Closeout TypesPUT/subaward/api/v1/closeout-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Closeout TypesPUT/subaward/api/v1/closeout-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Closeout TypesPATCH/subaward/api/v1/closeout-types/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Closeout TypesPOST/subaward/api/v1/closeout-types/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Closeout TypesPOST/subaward/api/v1/closeout-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"closeoutTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Closeout Types by KeyDELETE/subaward/api/v1/closeout-types/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Closeout TypesDELETE/subaward/api/v1/closeout-types/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Closeout Types with MatchingDELETE/subaward/api/v1/closeout-types/
Example URI
- _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
- closeoutTypeCode
string(optional)Closeout Type. Maximum length is 22. Validating pattern is ^[0-9]*$.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\u0000-\uFFFF]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalReleased Sub Award Amounts ¶
Get Released Sub Award Amounts by KeyGET/subaward/api/v1/released-sub-award-amounts/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Get All Released Sub Award AmountsGET/subaward/api/v1/released-sub-award-amounts/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get All Released Sub Award Amounts with FilteringGET/subaward/api/v1/released-sub-award-amounts/
Example URI
- _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.
- amountReleased
string(optional)Amount Released. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- comments
string(optional)Comments. Maximum length is 300. Validating pattern is .*.
- createdBy
string(optional)- createdDate
string(optional)- document
string(optional)Document. Maximum length is 4000. Validating pattern is ^[\p{Graph}]*$.
- documentNumber
string(optional)- effectiveDate
string(optional)Effective 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])$.
- endDate
string(optional)End 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])$.
- fileName
string(optional)File Name. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- invoiceNumber
string(optional)Invoice ID. Maximum length is 50. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- invoiceStatus
string(optional)Invoice Status. Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- mimeType
string(optional)Mime Type. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- sequenceNumber
string(optional)- startDate
string(optional)Start 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])$.
- subAwardAmtReleasedId
string(optional)Subaward Amt Released Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardCode
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardId
string(optional)
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Released Sub Award AmountsGET/subaward/api/v1/released-sub-award-amounts/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"amountReleased",
"comments",
"createdBy",
"createdDate",
"document",
"documentNumber",
"effectiveDate",
"endDate",
"fileName",
"invoiceNumber",
"invoiceStatus",
"mimeType",
"sequenceNumber",
"startDate",
"subAwardAmtReleasedId",
"subAwardCode",
"subAwardId"
],
"primaryKey": "subAwardAmtReleasedId"
}Get Blueprint API specification for Released Sub Award AmountsGET/subaward/api/v1/released-sub-award-amounts/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Released Sub Award Amounts.md"
transfer-encoding: chunkedUpdate Released Sub Award AmountsPUT/subaward/api/v1/released-sub-award-amounts/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Released Sub Award AmountsPUT/subaward/api/v1/released-sub-award-amounts/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Released Sub Award AmountsPATCH/subaward/api/v1/released-sub-award-amounts/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Released Sub Award AmountsPOST/subaward/api/v1/released-sub-award-amounts/
Example URI
- createMaintenanceDocument
string(required)will create a maintenance document associated with the new amount released instead of automatically applying it to the SubAward.
- route
string(required)will automatically submit the created maintenance document into routing if
createMaintenanceDocumentistrue, otherwise does nothing.
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}201Body
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Released Sub Award AmountsPOST/subaward/api/v1/released-sub-award-amounts/
Example URI
- createMaintenanceDocument
string(required)will create a maintenance document associated with the new amount released instead of automatically applying it to the SubAward.
- route
string(required)will automatically submit the created maintenance document into routing if
createMaintenanceDocumentistrue, otherwise does nothing.
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"amountReleased": "(val)",
"comments": "(val)",
"createdBy": "(val)",
"createdDate": "(val)",
"document": "(val)",
"documentNumber": "(val)",
"effectiveDate": "(val)",
"endDate": "(val)",
"fileName": "(val)",
"invoiceNumber": "(val)",
"invoiceStatus": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"startDate": "(val)",
"subAwardAmtReleasedId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Delete Released Sub Award Amounts by KeyDELETE/subaward/api/v1/released-sub-award-amounts/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Released Sub Award AmountsDELETE/subaward/api/v1/released-sub-award-amounts/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Released Sub Award Amounts with MatchingDELETE/subaward/api/v1/released-sub-award-amounts/
Example URI
- _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
- amountReleased
string(optional)Amount Released. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- comments
string(optional)Comments. Maximum length is 300. Validating pattern is .*.
- createdBy
string(optional)- createdDate
string(optional)- document
string(optional)Document. Maximum length is 4000. Validating pattern is ^[\p{Graph}]*$.
- documentNumber
string(optional)- effectiveDate
string(optional)Effective 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])$.
- endDate
string(optional)End 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])$.
- fileName
string(optional)File Name. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- invoiceNumber
string(optional)Invoice ID. Maximum length is 50. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- invoiceStatus
string(optional)Invoice Status. Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- mimeType
string(optional)Mime Type. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- sequenceNumber
string(optional)- startDate
string(optional)Start 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])$.
- subAwardAmtReleasedId
string(optional)Subaward Amt Released Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardCode
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardId
string(optional)
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Amount Infos ¶
Get Sub Award Amount Infos by KeyGET/subaward/api/v1/sub-award-amount-infos/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award Amount InfosGET/subaward/api/v1/sub-award-amount-infos/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Amount Infos with FilteringGET/subaward/api/v1/sub-award-amount-infos/
Example URI
- _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.
- anticipatedAmount
string(optional)Anticipated Amount. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- anticipatedChange
string(optional)Anticipated Change. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- anticipatedChangeDirect
string(optional)Anticipated Change Direct. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- anticipatedChangeIndirect
string(optional)Anticipated Change F&A. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- comments
string(optional)Comments. Maximum length is 300. Validating pattern is .*.
- effectiveDate
string(optional)Effective Date. Maximum length is 22. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- fileDataId
string(optional)- fileName
string(optional)File Name. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- mimeType
string(optional)Mime Type. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- modificationEffectiveDate
string(optional)Modification Effective 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])$.
- modificationID
string(optional)Modification ID. Maximum length is 50. Validating pattern is .*.
- modificationTypeCode
string(optional)Modification Type. Maximum length is 30. Validating pattern is ^[\p{Graph}]*$.
- obligatedAmount
string(optional)Obligated Amount. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- obligatedChange
string(optional)Obligated Change. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- obligatedChangeDirect
string(optional)Obligated Change Direct. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- obligatedChangeIndirect
string(optional)Obligated Change F&A. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- periodofPerformanceEndDate
string(optional)Period of Performance End 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])$.
- periodofPerformanceStartDate
string(optional)Period of Performance Start 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])$.
- purchaseOrderNum
string(optional)Purchase Order ID. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- rate
string(optional)Rate. Maximum length is 5. Validating pattern is ^([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.
- sequenceNumber
string(optional)- subAwardAmountInfoId
string(optional)Subaward Amount Info Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardCode
string(optional)- subAwardId
string(optional)Subaward Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award Amount InfosGET/subaward/api/v1/sub-award-amount-infos/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"anticipatedAmount",
"anticipatedChange",
"anticipatedChangeDirect",
"anticipatedChangeIndirect",
"comments",
"effectiveDate",
"fileDataId",
"fileName",
"mimeType",
"modificationEffectiveDate",
"modificationID",
"modificationTypeCode",
"obligatedAmount",
"obligatedChange",
"obligatedChangeDirect",
"obligatedChangeIndirect",
"periodofPerformanceEndDate",
"periodofPerformanceStartDate",
"purchaseOrderNum",
"rate",
"sequenceNumber",
"subAwardAmountInfoId",
"subAwardCode",
"subAwardId"
],
"primaryKey": "subAwardAmountInfoId"
}Get Blueprint API specification for Sub Award Amount InfosGET/subaward/api/v1/sub-award-amount-infos/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Amount Infos.md"
transfer-encoding: chunkedUpdate Sub Award Amount InfosPUT/subaward/api/v1/sub-award-amount-infos/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award Amount InfosPUT/subaward/api/v1/sub-award-amount-infos/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award Amount InfosPATCH/subaward/api/v1/sub-award-amount-infos/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award Amount InfosPOST/subaward/api/v1/sub-award-amount-infos/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award Amount InfosPOST/subaward/api/v1/sub-award-amount-infos/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"anticipatedAmount": "(val)",
"anticipatedChange": "(val)",
"anticipatedChangeDirect": "(val)",
"anticipatedChangeIndirect": "(val)",
"comments": "(val)",
"effectiveDate": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"mimeType": "(val)",
"modificationEffectiveDate": "(val)",
"modificationID": "(val)",
"modificationTypeCode": "(val)",
"obligatedAmount": "(val)",
"obligatedChange": "(val)",
"obligatedChangeDirect": "(val)",
"obligatedChangeIndirect": "(val)",
"periodofPerformanceEndDate": "(val)",
"periodofPerformanceStartDate": "(val)",
"purchaseOrderNum": "(val)",
"rate": "(val)",
"sequenceNumber": "(val)",
"subAwardAmountInfoId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Amount Infos by KeyDELETE/subaward/api/v1/sub-award-amount-infos/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award Amount InfosDELETE/subaward/api/v1/sub-award-amount-infos/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Amount Infos with MatchingDELETE/subaward/api/v1/sub-award-amount-infos/
Example URI
- _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
- anticipatedAmount
string(optional)Anticipated Amount. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- anticipatedChange
string(optional)Anticipated Change. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- anticipatedChangeDirect
string(optional)Anticipated Change Direct. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- anticipatedChangeIndirect
string(optional)Anticipated Change F&A. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- comments
string(optional)Comments. Maximum length is 300. Validating pattern is .*.
- effectiveDate
string(optional)Effective Date. Maximum length is 22. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.
- fileDataId
string(optional)- fileName
string(optional)File Name. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- mimeType
string(optional)Mime Type. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- modificationEffectiveDate
string(optional)Modification Effective 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])$.
- modificationID
string(optional)Modification ID. Maximum length is 50. Validating pattern is .*.
- modificationTypeCode
string(optional)Modification Type. Maximum length is 30. Validating pattern is ^[\p{Graph}]*$.
- obligatedAmount
string(optional)Obligated Amount. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- obligatedChange
string(optional)Obligated Change. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- obligatedChangeDirect
string(optional)Obligated Change Direct. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- obligatedChangeIndirect
string(optional)Obligated Change F&A. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.
- periodofPerformanceEndDate
string(optional)Period of Performance End 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])$.
- periodofPerformanceStartDate
string(optional)Period of Performance Start 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])$.
- purchaseOrderNum
string(optional)Purchase Order ID. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- rate
string(optional)Rate. Maximum length is 5. Validating pattern is ^([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.
- sequenceNumber
string(optional)- subAwardAmountInfoId
string(optional)Subaward Amount Info Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardCode
string(optional)- subAwardId
string(optional)Subaward Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Approval Types ¶
Get Sub Award Approval Types by KeyGET/subaward/api/v1/sub-award-approval-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"description": "(val)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award Approval TypesGET/subaward/api/v1/sub-award-approval-types/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Approval Types with FilteringGET/subaward/api/v1/sub-award-approval-types/
Example URI
- _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 ^[\u0000-\uFFFF]*$.
- subAwardApprovalTypeCode
string(optional)SubAward Approval Type Code. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award Approval TypesGET/subaward/api/v1/sub-award-approval-types/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"description",
"subAwardApprovalTypeCode"
],
"primaryKey": "subAwardApprovalTypeCode"
}Get Blueprint API specification for Sub Award Approval TypesGET/subaward/api/v1/sub-award-approval-types/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Approval Types.md"
transfer-encoding: chunkedUpdate Sub Award Approval TypesPUT/subaward/api/v1/sub-award-approval-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"description": "(val)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award Approval TypesPUT/subaward/api/v1/sub-award-approval-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award Approval TypesPATCH/subaward/api/v1/sub-award-approval-types/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"description": "(val)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award Approval TypesPOST/subaward/api/v1/sub-award-approval-types/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"description": "(val)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award Approval TypesPOST/subaward/api/v1/sub-award-approval-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"description": "(val)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardApprovalTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Approval Types by KeyDELETE/subaward/api/v1/sub-award-approval-types/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award Approval TypesDELETE/subaward/api/v1/sub-award-approval-types/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Approval Types with MatchingDELETE/subaward/api/v1/sub-award-approval-types/
Example URI
- _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 ^[\u0000-\uFFFF]*$.
- subAwardApprovalTypeCode
string(optional)SubAward Approval Type Code. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Attachment Types ¶
Get Sub Award Attachment Types by KeyGET/subaward/api/v1/sub-award-attachment-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award Attachment TypesGET/subaward/api/v1/sub-award-attachment-types/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Attachment Types with FilteringGET/subaward/api/v1/sub-award-attachment-types/
Example URI
- _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}]*$.
- subAwardAttachmentTypeCode
string(optional)Subaward Attachment Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award Attachment TypesGET/subaward/api/v1/sub-award-attachment-types/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"description",
"subAwardAttachmentTypeCode"
],
"primaryKey": "subAwardAttachmentTypeCode"
}Get Blueprint API specification for Sub Award Attachment TypesGET/subaward/api/v1/sub-award-attachment-types/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Attachment Types.md"
transfer-encoding: chunkedUpdate Sub Award Attachment TypesPUT/subaward/api/v1/sub-award-attachment-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award Attachment TypesPUT/subaward/api/v1/sub-award-attachment-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award Attachment TypesPATCH/subaward/api/v1/sub-award-attachment-types/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award Attachment TypesPOST/subaward/api/v1/sub-award-attachment-types/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award Attachment TypesPOST/subaward/api/v1/sub-award-attachment-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Attachment Types by KeyDELETE/subaward/api/v1/sub-award-attachment-types/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award Attachment TypesDELETE/subaward/api/v1/sub-award-attachment-types/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Attachment Types with MatchingDELETE/subaward/api/v1/sub-award-attachment-types/
Example URI
- _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}]*$.
- subAwardAttachmentTypeCode
string(optional)Subaward Attachment Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Attachments ¶
Get Sub Award Attachments by KeyGET/subaward/api/v1/sub-award-attachments/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award AttachmentsGET/subaward/api/v1/sub-award-attachments/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Attachments with FilteringGET/subaward/api/v1/sub-award-attachments/
Example URI
- _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.
- attachmentId
string(optional)Attachment ID. Maximum length is 15. Validating pattern is ^[0-9]*$.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- documentId
string(optional)Document Id. Maximum length is 4. Validating pattern is ^[0-9]*$.
- documentStatusCode
string(optional)- fileDataId
string(optional)- fileName
string(optional)File Name. 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}]*$.
- mimeType
string(optional)Mime Type. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- sequenceNumber
string(optional)- subAwardAttachmentTypeCode
string(optional)Attachment Type. Maximum length is 3. Validating pattern is ^[0-9]*$.
- subAwardCode
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardId
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award AttachmentsGET/subaward/api/v1/sub-award-attachments/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"attachmentId",
"description",
"documentId",
"documentStatusCode",
"fileDataId",
"fileName",
"lastUpdateTimestamp",
"lastUpdateUser",
"mimeType",
"sequenceNumber",
"subAwardAttachmentTypeCode",
"subAwardCode",
"subAwardId"
],
"primaryKey": "attachmentId"
}Get Blueprint API specification for Sub Award AttachmentsGET/subaward/api/v1/sub-award-attachments/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Attachments.md"
transfer-encoding: chunkedUpdate Sub Award AttachmentsPUT/subaward/api/v1/sub-award-attachments/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award AttachmentsPUT/subaward/api/v1/sub-award-attachments/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award AttachmentsPATCH/subaward/api/v1/sub-award-attachments/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award AttachmentsPOST/subaward/api/v1/sub-award-attachments/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award AttachmentsPOST/subaward/api/v1/sub-award-attachments/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Attachments by KeyDELETE/subaward/api/v1/sub-award-attachments/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award AttachmentsDELETE/subaward/api/v1/sub-award-attachments/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Attachments with MatchingDELETE/subaward/api/v1/sub-award-attachments/
Example URI
- _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
- attachmentId
string(optional)Attachment ID. Maximum length is 15. Validating pattern is ^[0-9]*$.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- documentId
string(optional)Document Id. Maximum length is 4. Validating pattern is ^[0-9]*$.
- documentStatusCode
string(optional)- fileDataId
string(optional)- fileName
string(optional)File Name. 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}]*$.
- mimeType
string(optional)Mime Type. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- sequenceNumber
string(optional)- subAwardAttachmentTypeCode
string(optional)Attachment Type. Maximum length is 3. Validating pattern is ^[0-9]*$.
- subAwardCode
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardId
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Closeouts ¶
Get Sub Award Closeouts by KeyGET/subaward/api/v1/sub-award-closeouts/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award CloseoutsGET/subaward/api/v1/sub-award-closeouts/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Closeouts with FilteringGET/subaward/api/v1/sub-award-closeouts/
Example URI
- _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.
- closeoutNumber
string(optional)Closeout Number. Maximum length is 22. Validating pattern is ^[0-9]*$.
- closeoutTypeCode
string(optional)Closeout Type Code. Maximum length is 22. Validating pattern is ^[\p{Graph}]*$.
- comments
string(optional)Comments. Maximum length is 4000. Validating pattern is .*.
- dateFollowup
string(optional)Date Followup. 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])$.
- dateReceived
string(optional)Date Received. 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])$.
- dateRequested
string(optional)Date Requested. 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)- subAwardCloseoutId
string(optional)Subaward Closeout Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardCode
string(optional)- subAwardId
string(optional)Subaward Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award CloseoutsGET/subaward/api/v1/sub-award-closeouts/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"closeoutNumber",
"closeoutTypeCode",
"comments",
"dateFollowup",
"dateReceived",
"dateRequested",
"sequenceNumber",
"subAwardCloseoutId",
"subAwardCode",
"subAwardId"
],
"primaryKey": "subAwardCloseoutId"
}Get Blueprint API specification for Sub Award CloseoutsGET/subaward/api/v1/sub-award-closeouts/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Closeouts.md"
transfer-encoding: chunkedUpdate Sub Award CloseoutsPUT/subaward/api/v1/sub-award-closeouts/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award CloseoutsPUT/subaward/api/v1/sub-award-closeouts/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award CloseoutsPATCH/subaward/api/v1/sub-award-closeouts/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award CloseoutsPOST/subaward/api/v1/sub-award-closeouts/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award CloseoutsPOST/subaward/api/v1/sub-award-closeouts/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"closeoutNumber": "(val)",
"closeoutTypeCode": "(val)",
"comments": "(val)",
"dateFollowup": "(val)",
"dateReceived": "(val)",
"dateRequested": "(val)",
"sequenceNumber": "(val)",
"subAwardCloseoutId": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Closeouts by KeyDELETE/subaward/api/v1/sub-award-closeouts/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award CloseoutsDELETE/subaward/api/v1/sub-award-closeouts/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Closeouts with MatchingDELETE/subaward/api/v1/sub-award-closeouts/
Example URI
- _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
- closeoutNumber
string(optional)Closeout Number. Maximum length is 22. Validating pattern is ^[0-9]*$.
- closeoutTypeCode
string(optional)Closeout Type Code. Maximum length is 22. Validating pattern is ^[\p{Graph}]*$.
- comments
string(optional)Comments. Maximum length is 4000. Validating pattern is .*.
- dateFollowup
string(optional)Date Followup. 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])$.
- dateReceived
string(optional)Date Received. 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])$.
- dateRequested
string(optional)Date Requested. 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)- subAwardCloseoutId
string(optional)Subaward Closeout Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardCode
string(optional)- subAwardId
string(optional)Subaward Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Contacts ¶
Get Sub Award Contacts by KeyGET/subaward/api/v1/sub-award-contacts/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award ContactsGET/subaward/api/v1/sub-award-contacts/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Contacts with FilteringGET/subaward/api/v1/sub-award-contacts/
Example URI
- _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.
- contactTypeCode
string(optional)Contact Type Code. Maximum length is 22. Validating pattern is ^[0-9]*$.
- rolodexId
string(optional)Rolodex Id. Maximum length is 22. Validating pattern is ^((-?[1-9][0-9])|[0])*$.
- sequenceNumber
string(optional)- subAwardCode
string(optional)- subAwardContactId
string(optional)Subaward Contact Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardId
string(optional)Subaward Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award ContactsGET/subaward/api/v1/sub-award-contacts/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"contactTypeCode",
"rolodexId",
"sequenceNumber",
"subAwardCode",
"subAwardContactId",
"subAwardId"
],
"primaryKey": "subAwardContactId"
}Get Blueprint API specification for Sub Award ContactsGET/subaward/api/v1/sub-award-contacts/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Contacts.md"
transfer-encoding: chunkedUpdate Sub Award ContactsPUT/subaward/api/v1/sub-award-contacts/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award ContactsPUT/subaward/api/v1/sub-award-contacts/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award ContactsPATCH/subaward/api/v1/sub-award-contacts/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award ContactsPOST/subaward/api/v1/sub-award-contacts/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award ContactsPOST/subaward/api/v1/sub-award-contacts/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"contactTypeCode": "(val)",
"rolodexId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardContactId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Contacts by KeyDELETE/subaward/api/v1/sub-award-contacts/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award ContactsDELETE/subaward/api/v1/sub-award-contacts/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Contacts with MatchingDELETE/subaward/api/v1/sub-award-contacts/
Example URI
- _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
- contactTypeCode
string(optional)Contact Type Code. Maximum length is 22. Validating pattern is ^[0-9]*$.
- rolodexId
string(optional)Rolodex Id. Maximum length is 22. Validating pattern is ^((-?[1-9][0-9])|[0])*$.
- sequenceNumber
string(optional)- subAwardCode
string(optional)- subAwardContactId
string(optional)Subaward Contact Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardId
string(optional)Subaward Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Copyright Types ¶
Get Sub Award Copyright Types by KeyGET/subaward/api/v1/sub-award-copyright-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award Copyright TypesGET/subaward/api/v1/sub-award-copyright-types/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
},
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Copyright Types with FilteringGET/subaward/api/v1/sub-award-copyright-types/
Example URI
- _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.
- copyRightTypeCode
string(optional)CopyRightTypeCode. Maximum length is 60. Validating pattern is ^[A-Za-z0-9]*$.
- copyRightTypeDescription
string(optional)copyRightTypeDescription. Maximum length is 60. Validating pattern is ^[\p{Graph}\p{Space}]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
},
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award Copyright TypesGET/subaward/api/v1/sub-award-copyright-types/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"copyRightTypeCode",
"copyRightTypeDescription"
],
"primaryKey": "copyRightTypeCode"
}Get Blueprint API specification for Sub Award Copyright TypesGET/subaward/api/v1/sub-award-copyright-types/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Copyright Types.md"
transfer-encoding: chunkedUpdate Sub Award Copyright TypesPUT/subaward/api/v1/sub-award-copyright-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award Copyright TypesPUT/subaward/api/v1/sub-award-copyright-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
},
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award Copyright TypesPATCH/subaward/api/v1/sub-award-copyright-types/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award Copyright TypesPOST/subaward/api/v1/sub-award-copyright-types/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award Copyright TypesPOST/subaward/api/v1/sub-award-copyright-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
},
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
},
{
"copyRightTypeCode": "(val)",
"copyRightTypeDescription": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Copyright Types by KeyDELETE/subaward/api/v1/sub-award-copyright-types/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award Copyright TypesDELETE/subaward/api/v1/sub-award-copyright-types/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Copyright Types with MatchingDELETE/subaward/api/v1/sub-award-copyright-types/
Example URI
- _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
- copyRightTypeCode
string(optional)CopyRightTypeCode. Maximum length is 60. Validating pattern is ^[A-Za-z0-9]*$.
- copyRightTypeDescription
string(optional)copyRightTypeDescription. Maximum length is 60. Validating pattern is ^[\p{Graph}\p{Space}]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Cost Types ¶
Get Sub Award Cost Types by KeyGET/subaward/api/v1/sub-award-cost-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award Cost TypesGET/subaward/api/v1/sub-award-cost-types/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
},
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Cost Types with FilteringGET/subaward/api/v1/sub-award-cost-types/
Example URI
- _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.
- active
string(optional)Active. Maximum length is 1. Validating pattern is .*.
- costTypeCode
string(optional)CostTypeCode. Maximum length is 60. Validating pattern is ^[A-Za-z0-9]*$.
- costTypeDescription
string(optional)CostTypeDescription. Maximum length is 60. Validating pattern is ^[\p{Graph}\p{Space}]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
},
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award Cost TypesGET/subaward/api/v1/sub-award-cost-types/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"active",
"costTypeCode",
"costTypeDescription"
],
"primaryKey": "costTypeCode"
}Get Blueprint API specification for Sub Award Cost TypesGET/subaward/api/v1/sub-award-cost-types/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Cost Types.md"
transfer-encoding: chunkedUpdate Sub Award Cost TypesPUT/subaward/api/v1/sub-award-cost-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award Cost TypesPUT/subaward/api/v1/sub-award-cost-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
},
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award Cost TypesPATCH/subaward/api/v1/sub-award-cost-types/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award Cost TypesPOST/subaward/api/v1/sub-award-cost-types/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award Cost TypesPOST/subaward/api/v1/sub-award-cost-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
},
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
},
{
"active": "(val)",
"costTypeCode": "(val)",
"costTypeDescription": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Cost Types by KeyDELETE/subaward/api/v1/sub-award-cost-types/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award Cost TypesDELETE/subaward/api/v1/sub-award-cost-types/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Cost Types with MatchingDELETE/subaward/api/v1/sub-award-cost-types/
Example URI
- _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
- active
string(optional)Active. Maximum length is 1. Validating pattern is .*.
- costTypeCode
string(optional)CostTypeCode. Maximum length is 60. Validating pattern is ^[A-Za-z0-9]*$.
- costTypeDescription
string(optional)CostTypeDescription. Maximum length is 60. Validating pattern is ^[\p{Graph}\p{Space}]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Custom Data ¶
Get Sub Award Custom Data by KeyGET/subaward/api/v1/sub-award-custom-data/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"customAttributeId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardCustomDataId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award Custom DataGET/subaward/api/v1/sub-award-custom-data/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"customAttributeId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardCustomDataId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"customAttributeId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardCustomDataId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Custom Data with FilteringGET/subaward/api/v1/sub-award-custom-data/
Example URI
- _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.
- customAttributeId
string(optional)- sequenceNumber
string(optional)- subAwardCode
string(optional)- subAwardCustomDataId
string(optional)- value
string(optional)Value. Maximum length is 2000. Validating pattern is ^[\u0000-\uFFFF]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"customAttributeId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardCustomDataId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"customAttributeId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardCustomDataId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award Custom DataGET/subaward/api/v1/sub-award-custom-data/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"customAttributeId",
"sequenceNumber",
"subAwardCode",
"subAwardCustomDataId",
"value"
],
"primaryKey": "subAwardCustomDataId"
}Get Blueprint API specification for Sub Award Custom DataGET/subaward/api/v1/sub-award-custom-data/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Custom Data.md"
transfer-encoding: chunkedSub Award Funding Sources ¶
Get Sub Award Funding Sources by KeyGET/subaward/api/v1/sub-award-funding-sources/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award Funding SourcesGET/subaward/api/v1/sub-award-funding-sources/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Funding Sources with FilteringGET/subaward/api/v1/sub-award-funding-sources/
Example URI
- _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.
- awardId
string(optional)A unique institutionally assigned number of a previously funded application. Maximum length is 12. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- sequenceNumber
string(optional)- subAwardCode
string(optional)- subAwardFundingSourceId
string(optional)Subaward Funding Source Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardId
string(optional)Subaward Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award Funding SourcesGET/subaward/api/v1/sub-award-funding-sources/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"awardId",
"sequenceNumber",
"subAwardCode",
"subAwardFundingSourceId",
"subAwardId"
],
"primaryKey": "subAwardFundingSourceId"
}Get Blueprint API specification for Sub Award Funding SourcesGET/subaward/api/v1/sub-award-funding-sources/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Funding Sources.md"
transfer-encoding: chunkedUpdate Sub Award Funding SourcesPUT/subaward/api/v1/sub-award-funding-sources/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award Funding SourcesPUT/subaward/api/v1/sub-award-funding-sources/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award Funding SourcesPATCH/subaward/api/v1/sub-award-funding-sources/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award Funding SourcesPOST/subaward/api/v1/sub-award-funding-sources/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award Funding SourcesPOST/subaward/api/v1/sub-award-funding-sources/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"awardId": "(val)",
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardFundingSourceId": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Funding Sources by KeyDELETE/subaward/api/v1/sub-award-funding-sources/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award Funding SourcesDELETE/subaward/api/v1/sub-award-funding-sources/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Funding Sources with MatchingDELETE/subaward/api/v1/sub-award-funding-sources/
Example URI
- _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
- awardId
string(optional)A unique institutionally assigned number of a previously funded application. Maximum length is 12. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- sequenceNumber
string(optional)- subAwardCode
string(optional)- subAwardFundingSourceId
string(optional)Subaward Funding Source Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardId
string(optional)Subaward Id. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Person Mass Changes ¶
Get Sub Award Person Mass Changes by KeyGET/subaward/api/v1/sub-award-person-mass-changes/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award Person Mass ChangesGET/subaward/api/v1/sub-award-person-mass-changes/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
},
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Person Mass Changes with FilteringGET/subaward/api/v1/sub-award-person-mass-changes/
Example URI
- _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.
- contact
string(optional)Contact. Maximum length is 1. Validating pattern is .*.
- personMassChangeId
string(optional)Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.
- requisitioner
string(optional)Requisitioner. Maximum length is 1. Validating pattern is .*.
- subawardPersonMassChangeId
string(optional)Subaward Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
},
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award Person Mass ChangesGET/subaward/api/v1/sub-award-person-mass-changes/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"contact",
"personMassChangeId",
"requisitioner",
"subawardPersonMassChangeId"
],
"primaryKey": "subawardPersonMassChangeId"
}Get Blueprint API specification for Sub Award Person Mass ChangesGET/subaward/api/v1/sub-award-person-mass-changes/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Person Mass Changes.md"
transfer-encoding: chunkedUpdate Sub Award Person Mass ChangesPUT/subaward/api/v1/sub-award-person-mass-changes/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award Person Mass ChangesPUT/subaward/api/v1/sub-award-person-mass-changes/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
},
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award Person Mass ChangesPATCH/subaward/api/v1/sub-award-person-mass-changes/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award Person Mass ChangesPOST/subaward/api/v1/sub-award-person-mass-changes/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award Person Mass ChangesPOST/subaward/api/v1/sub-award-person-mass-changes/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
},
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
},
{
"contact": "(val)",
"personMassChangeId": "(val)",
"requisitioner": "(val)",
"subawardPersonMassChangeId": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Person Mass Changes by KeyDELETE/subaward/api/v1/sub-award-person-mass-changes/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award Person Mass ChangesDELETE/subaward/api/v1/sub-award-person-mass-changes/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Person Mass Changes with MatchingDELETE/subaward/api/v1/sub-award-person-mass-changes/
Example URI
- _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
- contact
string(optional)Contact. Maximum length is 1. Validating pattern is .*.
- personMassChangeId
string(optional)Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.
- requisitioner
string(optional)Requisitioner. Maximum length is 1. Validating pattern is .*.
- subawardPersonMassChangeId
string(optional)Subaward Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Report Types ¶
Get Sub Award Report Types by KeyGET/subaward/api/v1/sub-award-report-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"description": "(val)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award Report TypesGET/subaward/api/v1/sub-award-report-types/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Report Types with FilteringGET/subaward/api/v1/sub-award-report-types/
Example URI
- _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}]*$.
- sortId
string(optional)- subAwardReportTypeCode
string(optional)Report Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award Report TypesGET/subaward/api/v1/sub-award-report-types/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"description",
"sortId",
"subAwardReportTypeCode"
],
"primaryKey": "subAwardReportTypeCode"
}Get Blueprint API specification for Sub Award Report TypesGET/subaward/api/v1/sub-award-report-types/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Report Types.md"
transfer-encoding: chunkedUpdate Sub Award Report TypesPUT/subaward/api/v1/sub-award-report-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"description": "(val)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award Report TypesPUT/subaward/api/v1/sub-award-report-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award Report TypesPATCH/subaward/api/v1/sub-award-report-types/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"description": "(val)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award Report TypesPOST/subaward/api/v1/sub-award-report-types/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"description": "(val)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award Report TypesPOST/subaward/api/v1/sub-award-report-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"description": "(val)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"sortId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Report Types by KeyDELETE/subaward/api/v1/sub-award-report-types/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award Report TypesDELETE/subaward/api/v1/sub-award-report-types/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Report Types with MatchingDELETE/subaward/api/v1/sub-award-report-types/
Example URI
- _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}]*$.
- sortId
string(optional)- subAwardReportTypeCode
string(optional)Report Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Reports ¶
Get Sub Award Reports by KeyGET/subaward/api/v1/sub-award-reports/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award ReportsGET/subaward/api/v1/sub-award-reports/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Reports with FilteringGET/subaward/api/v1/sub-award-reports/
Example URI
- _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.
- sequenceNumber
string(optional)- subAwardCode
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardId
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardReportId
string(optional)Report ID. Maximum length is 15. Validating pattern is ^[0-9]*$.
- subAwardReportTypeCode
string(optional)Report Type. Maximum length is 3. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award ReportsGET/subaward/api/v1/sub-award-reports/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"sequenceNumber",
"subAwardCode",
"subAwardId",
"subAwardReportId",
"subAwardReportTypeCode"
],
"primaryKey": "subAwardReportId"
}Get Blueprint API specification for Sub Award ReportsGET/subaward/api/v1/sub-award-reports/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Reports.md"
transfer-encoding: chunkedUpdate Sub Award ReportsPUT/subaward/api/v1/sub-award-reports/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award ReportsPUT/subaward/api/v1/sub-award-reports/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award ReportsPATCH/subaward/api/v1/sub-award-reports/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award ReportsPOST/subaward/api/v1/sub-award-reports/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award ReportsPOST/subaward/api/v1/sub-award-reports/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"sequenceNumber": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardReportId": "(val)",
"subAwardReportTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Reports by KeyDELETE/subaward/api/v1/sub-award-reports/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award ReportsDELETE/subaward/api/v1/sub-award-reports/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Reports with MatchingDELETE/subaward/api/v1/sub-award-reports/
Example URI
- _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
- sequenceNumber
string(optional)- subAwardCode
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardId
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardReportId
string(optional)Report ID. Maximum length is 15. Validating pattern is ^[0-9]*$.
- subAwardReportTypeCode
string(optional)Report Type. Maximum length is 3. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Statuses ¶
Get Sub Award Statuses by KeyGET/subaward/api/v1/sub-award-statuses/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"description": "(val)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award StatusesGET/subaward/api/v1/sub-award-statuses/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Statuses with FilteringGET/subaward/api/v1/sub-award-statuses/
Example URI
- _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 ^[\u0000-\uFFFF]*$.
- subAwardStatusCode
string(optional)Subaward Status Code. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award StatusesGET/subaward/api/v1/sub-award-statuses/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"description",
"subAwardStatusCode"
],
"primaryKey": "subAwardStatusCode"
}Get Blueprint API specification for Sub Award StatusesGET/subaward/api/v1/sub-award-statuses/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Statuses.md"
transfer-encoding: chunkedUpdate Sub Award StatusesPUT/subaward/api/v1/sub-award-statuses/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"description": "(val)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award StatusesPUT/subaward/api/v1/sub-award-statuses/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award StatusesPATCH/subaward/api/v1/sub-award-statuses/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"description": "(val)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award StatusesPOST/subaward/api/v1/sub-award-statuses/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"description": "(val)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award StatusesPOST/subaward/api/v1/sub-award-statuses/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"description": "(val)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardStatusCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Statuses by KeyDELETE/subaward/api/v1/sub-award-statuses/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award StatusesDELETE/subaward/api/v1/sub-award-statuses/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Statuses with MatchingDELETE/subaward/api/v1/sub-award-statuses/
Example URI
- _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 ^[\u0000-\uFFFF]*$.
- subAwardStatusCode
string(optional)Subaward Status Code. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Template Attachment Types ¶
Get Sub Award Template Attachment Types by KeyGET/subaward/api/v1/sub-award-template-attachment-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award Template Attachment TypesGET/subaward/api/v1/sub-award-template-attachment-types/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Template Attachment Types with FilteringGET/subaward/api/v1/sub-award-template-attachment-types/
Example URI
- _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}]*$.
- subAwardAttachmentTypeCode
string(optional)Subaward Template Attachment Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award Template Attachment TypesGET/subaward/api/v1/sub-award-template-attachment-types/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"description",
"subAwardAttachmentTypeCode"
],
"primaryKey": "subAwardAttachmentTypeCode"
}Get Blueprint API specification for Sub Award Template Attachment TypesGET/subaward/api/v1/sub-award-template-attachment-types/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Template Attachment Types.md"
transfer-encoding: chunkedUpdate Sub Award Template Attachment TypesPUT/subaward/api/v1/sub-award-template-attachment-types/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award Template Attachment TypesPUT/subaward/api/v1/sub-award-template-attachment-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award Template Attachment TypesPATCH/subaward/api/v1/sub-award-template-attachment-types/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award Template Attachment TypesPOST/subaward/api/v1/sub-award-template-attachment-types/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award Template Attachment TypesPOST/subaward/api/v1/sub-award-template-attachment-types/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"description": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Template Attachment Types by KeyDELETE/subaward/api/v1/sub-award-template-attachment-types/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award Template Attachment TypesDELETE/subaward/api/v1/sub-award-template-attachment-types/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Template Attachment Types with MatchingDELETE/subaward/api/v1/sub-award-template-attachment-types/
Example URI
- _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}]*$.
- subAwardAttachmentTypeCode
string(optional)Subaward Template Attachment Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Template Attachments ¶
Get Sub Award Template Attachments by KeyGET/subaward/api/v1/sub-award-template-attachments/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award Template AttachmentsGET/subaward/api/v1/sub-award-template-attachments/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Template Attachments with FilteringGET/subaward/api/v1/sub-award-template-attachments/
Example URI
- _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.
- attachmentId
string(optional)Attachment ID. Maximum length is 15. Validating pattern is ^[0-9]*$.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- documentId
string(optional)Document Id. Maximum length is 4. Validating pattern is ^[0-9]*$.
- documentStatusCode
string(optional)- fileDataId
string(optional)- fileName
string(optional)File Name. 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}]*$.
- mimeType
string(optional)Mime Type. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- sequenceNumber
string(optional)- subAwardAttachmentTypeCode
string(optional)Attachment Type. Maximum length is 3. Validating pattern is ^[0-9]*$.
- subAwardCode
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardId
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award Template AttachmentsGET/subaward/api/v1/sub-award-template-attachments/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"attachmentId",
"description",
"documentId",
"documentStatusCode",
"fileDataId",
"fileName",
"lastUpdateTimestamp",
"lastUpdateUser",
"mimeType",
"sequenceNumber",
"subAwardAttachmentTypeCode",
"subAwardCode",
"subAwardId"
],
"primaryKey": "attachmentId"
}Get Blueprint API specification for Sub Award Template AttachmentsGET/subaward/api/v1/sub-award-template-attachments/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Template Attachments.md"
transfer-encoding: chunkedUpdate Sub Award Template AttachmentsPUT/subaward/api/v1/sub-award-template-attachments/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award Template AttachmentsPUT/subaward/api/v1/sub-award-template-attachments/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award Template AttachmentsPATCH/subaward/api/v1/sub-award-template-attachments/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award Template AttachmentsPOST/subaward/api/v1/sub-award-template-attachments/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award Template AttachmentsPOST/subaward/api/v1/sub-award-template-attachments/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
},
{
"attachmentId": "(val)",
"description": "(val)",
"documentId": "(val)",
"documentStatusCode": "(val)",
"fileDataId": "(val)",
"fileName": "(val)",
"lastUpdateTimestamp": "(val)",
"lastUpdateUser": "(val)",
"mimeType": "(val)",
"sequenceNumber": "(val)",
"subAwardAttachmentTypeCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Template Attachments by KeyDELETE/subaward/api/v1/sub-award-template-attachments/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award Template AttachmentsDELETE/subaward/api/v1/sub-award-template-attachments/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Template Attachments with MatchingDELETE/subaward/api/v1/sub-award-template-attachments/
Example URI
- _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
- attachmentId
string(optional)Attachment ID. Maximum length is 15. Validating pattern is ^[0-9]*$.
- description
string(optional)Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- documentId
string(optional)Document Id. Maximum length is 4. Validating pattern is ^[0-9]*$.
- documentStatusCode
string(optional)- fileDataId
string(optional)- fileName
string(optional)File Name. 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}]*$.
- mimeType
string(optional)Mime Type. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- sequenceNumber
string(optional)- subAwardAttachmentTypeCode
string(optional)Attachment Type. Maximum length is 3. Validating pattern is ^[0-9]*$.
- subAwardCode
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardId
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Award Template Infos ¶
Get Sub Award Template Infos by KeyGET/subaward/api/v1/sub-award-template-infos/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
}Get All Sub Award Template InfosGET/subaward/api/v1/sub-award-template-infos/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
},
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Award Template Infos with FilteringGET/subaward/api/v1/sub-award-template-infos/
Example URI
- _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.
- additionalTerms
string(optional)Additional Terms. Maximum length is 3500. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- animalFlag
string(optional)Animal Subjects Included. Maximum length is 1. Validating pattern is .*.
- animalPteNrCd
string(optional)Animal Subjects Not Required Reason. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- animalPteSendCd
string(optional)Animal Subjects PTE requires verification to be sent. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- applicableProgramRegsDate
string(optional)Applicable Program Regulations 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])$.
- applicableProgramRegulations
string(optional)Applicable Program Regulations. Maximum length is 50. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- automaticCarryForward
string(optional)Automatic Carry Forward. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- carryForwardRequestsSentTo
string(optional)Carry Forward Requests Sent To. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- changeRequestsContact
string(optional)Change Requests Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- copyRightType
string(optional)Copyrights. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- dataSharingAttachment
string(optional)Data Sharing Attachment. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- dataSharingCd
string(optional)Data Sharing. Maximum length is 4. Validating pattern is ^[A-Za-z0-9]*$.
- exemptFromRprtgExecComp
string(optional)Exempt from reporting exec compensation. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- fcio
string(optional)Prime Sponsor is PHS for FCOI regulation. Maximum length is 1. Validating pattern is .*.
- fcioSubrecPolicyCd
string(optional)Applicable FCOI policy for subrecipient. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- finalStatementDueCd
string(optional)Final Statement Due. Maximum length is 4. Validating pattern is ^[A-Za-z0-9]*$.
- finalStmtOfCostscontact
string(optional)Final Statement of Costs Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- humanDataExchangeAgreeCd
string(optional)Human Subjects Data will be exchanged under this agreement. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- humanDataExchangeTermsCd
string(optional)Human Subjects PTE will set forth the terms of exchange of human subjects data. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- humanExemptDocumentation
string(optional)Exempt Documentation. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- humanFlag
string(optional)Human Subjects Included. Maximum length is 1. Validating pattern is .*.
- humanPteNrCd
string(optional)Human Subjects Not Required Reason. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- humanPteSendCd
string(optional)Human Subjects PTE requires verification to be sent. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- humanSubjects
string(optional)Human Subjects Included. Maximum length is 1. Validating pattern is .*.
- includesClinicalTrials
string(optional)Includes clinical trials?. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- includesCostSharing
string(optional)Includes Cost Sharing. Maximum length is 1. Validating pattern is .*.
- invoiceAddressDifferent
string(optional)Invoice Address different from Financial contact’s. Maximum length is 1. Validating pattern is .*.
- invoiceEmailDifferent
string(optional)Email different from Financial Contact’s. Maximum length is 1. Validating pattern is .*.
- invoiceOrPaymentContact
string(optional)Invoice / Payment Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- invoicesEmailed
string(optional)Invoices emailed. Maximum length is 1. Validating pattern is .*.
- irbIacucContact
string(optional)IRB / IACUC Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- mpiAward
string(optional)Is an MPI award. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- mpiLeadershipPlan
string(optional)MPI Leadership Plan. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- noCostExtensionContact
string(optional)No Cost Extension Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- parentCongressionalDistrict
string(optional)Parent Congressional District. Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- parentDunsNumber
string(optional)Parent UEI/DUNS (if applicable). Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- perfSiteDiffFromOrgAddr
string(optional)Performance Site same as Org address?. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- perfSiteSameAsSubPiAddr
string(optional)Performance Site same as Sub PI address?. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- rAndD
string(optional)Is R&D. Maximum length is 1. Validating pattern is .*.
- sequenceNumber
string(optional)- sowOrSubProposalBudget
string(optional)SOW/Budget specified in proposal. Maximum length is 1. Validating pattern is .*.
- subAwardCode
string(optional)- subAwardId
string(optional)- subChangeRequestsContact
string(optional)Sub Change Requests Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- subExemptFromReportingComp
string(optional)Sub Exempt From Reporting Compensation?. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- subProposalDate
string(optional)SubProposal 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])$.
- subRegisteredInCcr
string(optional)Sub Registered in CCR?. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- subTerminationContact
string(optional)Sub Termination Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- terminationContact
string(optional)Termination Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- treatmentOfIncome
string(optional)Treatment of Income. Maximum length is 60. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- treatmentPrgmIncomeAdditive
string(optional)Treatment of Program Income Additive. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
},
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub Award Template InfosGET/subaward/api/v1/sub-award-template-infos/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"additionalTerms",
"animalFlag",
"animalPteNrCd",
"animalPteSendCd",
"applicableProgramRegsDate",
"applicableProgramRegulations",
"automaticCarryForward",
"carryForwardRequestsSentTo",
"changeRequestsContact",
"copyRightType",
"dataSharingAttachment",
"dataSharingCd",
"exemptFromRprtgExecComp",
"fcio",
"fcioSubrecPolicyCd",
"finalStatementDueCd",
"finalStmtOfCostscontact",
"humanDataExchangeAgreeCd",
"humanDataExchangeTermsCd",
"humanExemptDocumentation",
"humanFlag",
"humanPteNrCd",
"humanPteSendCd",
"humanSubjects",
"includesClinicalTrials",
"includesCostSharing",
"invoiceAddressDifferent",
"invoiceEmailDifferent",
"invoiceOrPaymentContact",
"invoicesEmailed",
"irbIacucContact",
"mpiAward",
"mpiLeadershipPlan",
"noCostExtensionContact",
"parentCongressionalDistrict",
"parentDunsNumber",
"perfSiteDiffFromOrgAddr",
"perfSiteSameAsSubPiAddr",
"rAndD",
"sequenceNumber",
"sowOrSubProposalBudget",
"subAwardCode",
"subAwardId",
"subChangeRequestsContact",
"subExemptFromReportingComp",
"subProposalDate",
"subRegisteredInCcr",
"subTerminationContact",
"terminationContact",
"treatmentOfIncome",
"treatmentPrgmIncomeAdditive"
],
"primaryKey": "subAwardId"
}Get Blueprint API specification for Sub Award Template InfosGET/subaward/api/v1/sub-award-template-infos/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Template Infos.md"
transfer-encoding: chunkedUpdate Sub Award Template InfosPUT/subaward/api/v1/sub-award-template-infos/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
}204Update Multiple Sub Award Template InfosPUT/subaward/api/v1/sub-award-template-infos/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
},
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
}
]204Update Specific Attributes Sub Award Template InfosPATCH/subaward/api/v1/sub-award-template-infos/(key)
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the update
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Body
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
}Insert Sub Award Template InfosPOST/subaward/api/v1/sub-award-template-infos/
Example URI
- createMaintenanceDocument
string(required)if
true, will create a maintenance document for the insertion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json201Body
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sub Award Template InfosPOST/subaward/api/v1/sub-award-template-infos/
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
},
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
}
]201Body
[
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
},
{
"additionalTerms": "(val)",
"animalFlag": "(val)",
"animalPteNrCd": "(val)",
"animalPteSendCd": "(val)",
"applicableProgramRegsDate": "(val)",
"applicableProgramRegulations": "(val)",
"automaticCarryForward": "(val)",
"carryForwardRequestsSentTo": "(val)",
"changeRequestsContact": "(val)",
"copyRightType": "(val)",
"dataSharingAttachment": "(val)",
"dataSharingCd": "(val)",
"exemptFromRprtgExecComp": "(val)",
"fcio": "(val)",
"fcioSubrecPolicyCd": "(val)",
"finalStatementDueCd": "(val)",
"finalStmtOfCostscontact": "(val)",
"humanDataExchangeAgreeCd": "(val)",
"humanDataExchangeTermsCd": "(val)",
"humanExemptDocumentation": "(val)",
"humanFlag": "(val)",
"humanPteNrCd": "(val)",
"humanPteSendCd": "(val)",
"humanSubjects": "(val)",
"includesClinicalTrials": "(val)",
"includesCostSharing": "(val)",
"invoiceAddressDifferent": "(val)",
"invoiceEmailDifferent": "(val)",
"invoiceOrPaymentContact": "(val)",
"invoicesEmailed": "(val)",
"irbIacucContact": "(val)",
"mpiAward": "(val)",
"mpiLeadershipPlan": "(val)",
"noCostExtensionContact": "(val)",
"parentCongressionalDistrict": "(val)",
"parentDunsNumber": "(val)",
"perfSiteDiffFromOrgAddr": "(val)",
"perfSiteSameAsSubPiAddr": "(val)",
"rAndD": "(val)",
"sequenceNumber": "(val)",
"sowOrSubProposalBudget": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subChangeRequestsContact": "(val)",
"subExemptFromReportingComp": "(val)",
"subProposalDate": "(val)",
"subRegisteredInCcr": "(val)",
"subTerminationContact": "(val)",
"terminationContact": "(val)",
"treatmentOfIncome": "(val)",
"treatmentPrgmIncomeAdditive": "(val)",
"_primaryKey": "(val)"
}
]Delete Sub Award Template Infos by KeyDELETE/subaward/api/v1/sub-award-template-infos/(key)
Example URI
- createMaintenanceDocument
string(required)if true, will create a maintenance document for the deletion
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Delete All Sub Award Template InfosDELETE/subaward/api/v1/sub-award-template-infos/
Example URI
- _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
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 Sub Award Template Infos with MatchingDELETE/subaward/api/v1/sub-award-template-infos/
Example URI
- _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
- additionalTerms
string(optional)Additional Terms. Maximum length is 3500. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- animalFlag
string(optional)Animal Subjects Included. Maximum length is 1. Validating pattern is .*.
- animalPteNrCd
string(optional)Animal Subjects Not Required Reason. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- animalPteSendCd
string(optional)Animal Subjects PTE requires verification to be sent. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- applicableProgramRegsDate
string(optional)Applicable Program Regulations 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])$.
- applicableProgramRegulations
string(optional)Applicable Program Regulations. Maximum length is 50. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- automaticCarryForward
string(optional)Automatic Carry Forward. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- carryForwardRequestsSentTo
string(optional)Carry Forward Requests Sent To. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- changeRequestsContact
string(optional)Change Requests Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- copyRightType
string(optional)Copyrights. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- dataSharingAttachment
string(optional)Data Sharing Attachment. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- dataSharingCd
string(optional)Data Sharing. Maximum length is 4. Validating pattern is ^[A-Za-z0-9]*$.
- exemptFromRprtgExecComp
string(optional)Exempt from reporting exec compensation. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- fcio
string(optional)Prime Sponsor is PHS for FCOI regulation. Maximum length is 1. Validating pattern is .*.
- fcioSubrecPolicyCd
string(optional)Applicable FCOI policy for subrecipient. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- finalStatementDueCd
string(optional)Final Statement Due. Maximum length is 4. Validating pattern is ^[A-Za-z0-9]*$.
- finalStmtOfCostscontact
string(optional)Final Statement of Costs Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- humanDataExchangeAgreeCd
string(optional)Human Subjects Data will be exchanged under this agreement. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- humanDataExchangeTermsCd
string(optional)Human Subjects PTE will set forth the terms of exchange of human subjects data. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- humanExemptDocumentation
string(optional)Exempt Documentation. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- humanFlag
string(optional)Human Subjects Included. Maximum length is 1. Validating pattern is .*.
- humanPteNrCd
string(optional)Human Subjects Not Required Reason. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- humanPteSendCd
string(optional)Human Subjects PTE requires verification to be sent. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- humanSubjects
string(optional)Human Subjects Included. Maximum length is 1. Validating pattern is .*.
- includesClinicalTrials
string(optional)Includes clinical trials?. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- includesCostSharing
string(optional)Includes Cost Sharing. Maximum length is 1. Validating pattern is .*.
- invoiceAddressDifferent
string(optional)Invoice Address different from Financial contact’s. Maximum length is 1. Validating pattern is .*.
- invoiceEmailDifferent
string(optional)Email different from Financial Contact’s. Maximum length is 1. Validating pattern is .*.
- invoiceOrPaymentContact
string(optional)Invoice / Payment Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- invoicesEmailed
string(optional)Invoices emailed. Maximum length is 1. Validating pattern is .*.
- irbIacucContact
string(optional)IRB / IACUC Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- mpiAward
string(optional)Is an MPI award. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- mpiLeadershipPlan
string(optional)MPI Leadership Plan. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.
- noCostExtensionContact
string(optional)No Cost Extension Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- parentCongressionalDistrict
string(optional)Parent Congressional District. Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- parentDunsNumber
string(optional)Parent UEI/DUNS (if applicable). Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- perfSiteDiffFromOrgAddr
string(optional)Performance Site same as Org address?. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- perfSiteSameAsSubPiAddr
string(optional)Performance Site same as Sub PI address?. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- rAndD
string(optional)Is R&D. Maximum length is 1. Validating pattern is .*.
- sequenceNumber
string(optional)- sowOrSubProposalBudget
string(optional)SOW/Budget specified in proposal. Maximum length is 1. Validating pattern is .*.
- subAwardCode
string(optional)- subAwardId
string(optional)- subChangeRequestsContact
string(optional)Sub Change Requests Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- subExemptFromReportingComp
string(optional)Sub Exempt From Reporting Compensation?. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- subProposalDate
string(optional)SubProposal 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])$.
- subRegisteredInCcr
string(optional)Sub Registered in CCR?. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
- subTerminationContact
string(optional)Sub Termination Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- terminationContact
string(optional)Termination Contact. Maximum length is 10. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- treatmentOfIncome
string(optional)Treatment of Income. Maximum length is 60. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- treatmentPrgmIncomeAdditive
string(optional)Treatment of Program Income Additive. Maximum length is 1. Validating pattern is ^[A-Za-z0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json204Headers
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 totalSub Awards ¶
Get Sub Awards by KeyGET/subaward/api/v1/sub-awards/(key)
Example URI
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"subAwardDocument.documentNumber": "(val)",
"accountNumber": "(val)",
"archiveLocation": "(val)",
"closeoutDate": "(val)",
"comments": "(val)",
"costType": "(val)",
"deMinimus": "(val)",
"endDate": "(val)",
"executionDate": "(val)",
"fAndARate": "(val)",
"fedAwardProjDesc": "(val)",
"ffataRequired": "(val)",
"fsrsSubawardNumber": "(val)",
"organizationId": "(val)",
"requisitionId": "(val)",
"requisitionerId": "(val)",
"requisitionerUnit": "(val)",
"sequenceNumber": "(val)",
"siteInvestigator": "(val)",
"startDate": "(val)",
"statusCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardSequenceStatus": "(val)",
"subAwardTypeCode": "(val)",
"title": "(val)",
"vendorNumber": "(val)",
"_primaryKey": "(val)"
}Get All Sub AwardsGET/subaward/api/v1/sub-awards/
Example URI
- _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.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"subAwardDocument.documentNumber": "(val)",
"accountNumber": "(val)",
"archiveLocation": "(val)",
"closeoutDate": "(val)",
"comments": "(val)",
"costType": "(val)",
"deMinimus": "(val)",
"endDate": "(val)",
"executionDate": "(val)",
"fAndARate": "(val)",
"fedAwardProjDesc": "(val)",
"ffataRequired": "(val)",
"fsrsSubawardNumber": "(val)",
"organizationId": "(val)",
"requisitionId": "(val)",
"requisitionerId": "(val)",
"requisitionerUnit": "(val)",
"sequenceNumber": "(val)",
"siteInvestigator": "(val)",
"startDate": "(val)",
"statusCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardSequenceStatus": "(val)",
"subAwardTypeCode": "(val)",
"title": "(val)",
"vendorNumber": "(val)",
"_primaryKey": "(val)"
},
{
"subAwardDocument.documentNumber": "(val)",
"accountNumber": "(val)",
"archiveLocation": "(val)",
"closeoutDate": "(val)",
"comments": "(val)",
"costType": "(val)",
"deMinimus": "(val)",
"endDate": "(val)",
"executionDate": "(val)",
"fAndARate": "(val)",
"fedAwardProjDesc": "(val)",
"ffataRequired": "(val)",
"fsrsSubawardNumber": "(val)",
"organizationId": "(val)",
"requisitionId": "(val)",
"requisitionerId": "(val)",
"requisitionerUnit": "(val)",
"sequenceNumber": "(val)",
"siteInvestigator": "(val)",
"startDate": "(val)",
"statusCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardSequenceStatus": "(val)",
"subAwardTypeCode": "(val)",
"title": "(val)",
"vendorNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Sub Awards with FilteringGET/subaward/api/v1/sub-awards/
Example URI
- _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.
- subAwardDocument.documentNumber
string(optional)- accountNumber
string(optional)Account ID. Maximum length is 25. Validating pattern is ^[A-Za-z0-9]*$.
- archiveLocation
string(optional)Archive Location. Maximum length is 50. Validating pattern is ^[A-Za-z0-9]*$.
- closeoutDate
string(optional)Closeout 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])$.
- comments
string(optional)Comments. Maximum length is 4000. Validating pattern is .*.
- costType
string(optional)Cost Type. Maximum length is 22. Validating pattern is ^[0-9]*$.
- deMinimus
string(optional)De Minimis. Maximum length is 1. Validating pattern is .*.
- endDate
string(optional)End 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])$.
- executionDate
string(optional)Execution 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])$.
- fAndARate
string(optional)F & A Rate. Maximum length is 5. Validating pattern is ^([0-9]{0,2}.[0-9]{1,2}|[0-9]{1,2})$.
- fedAwardProjDesc
string(optional)Federal Award Project Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- ffataRequired
string(optional)FFATA Required. Maximum length is 1. Validating pattern is .*.
- fsrsSubawardNumber
string(optional)FSRS Subaward Number. Maximum length is 25. Validating pattern is ^[\p{Graph}]*$.
- organizationId
string(optional)Subrecipient. Maximum length is 60. Validating pattern is ^[A-Za-z0-9]*$.
- requisitionId
string(optional)Requisition ID. Maximum length is 50. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- requisitionerId
string(optional)KcPerson Id. Maximum length is 40. Validating pattern is ^[\p{Graph}]*$.
- requisitionerUnit
string(optional)Requisitioner Unit. Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- sequenceNumber
string(optional)- siteInvestigator
string(optional)Site Investigator. Maximum length is 22. Validating pattern is ^((-?[1-9][0-9])|[0])*$.
- startDate
string(optional)Start 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])$.
- statusCode
string(optional)Status Code. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardCode
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardId
string(optional)Subaward ID. Maximum length is 22. Validating pattern is ^[0-9]*$.
- subAwardSequenceStatus
string(optional)Document Status. Maximum length is 20. Validating pattern is ^[A-Za-z]*$.
- subAwardTypeCode
string(optional)Subaward Type. Maximum length is 22. Validating pattern is ^[0-9]*$.
- title
string(optional)Title. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.
- vendorNumber
string(optional)Vendor ID. Maximum length is 10. Validating pattern is ^[A-Za-z0-9]*$.
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
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
[
{
"subAwardDocument.documentNumber": "(val)",
"accountNumber": "(val)",
"archiveLocation": "(val)",
"closeoutDate": "(val)",
"comments": "(val)",
"costType": "(val)",
"deMinimus": "(val)",
"endDate": "(val)",
"executionDate": "(val)",
"fAndARate": "(val)",
"fedAwardProjDesc": "(val)",
"ffataRequired": "(val)",
"fsrsSubawardNumber": "(val)",
"organizationId": "(val)",
"requisitionId": "(val)",
"requisitionerId": "(val)",
"requisitionerUnit": "(val)",
"sequenceNumber": "(val)",
"siteInvestigator": "(val)",
"startDate": "(val)",
"statusCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardSequenceStatus": "(val)",
"subAwardTypeCode": "(val)",
"title": "(val)",
"vendorNumber": "(val)",
"_primaryKey": "(val)"
},
{
"subAwardDocument.documentNumber": "(val)",
"accountNumber": "(val)",
"archiveLocation": "(val)",
"closeoutDate": "(val)",
"comments": "(val)",
"costType": "(val)",
"deMinimus": "(val)",
"endDate": "(val)",
"executionDate": "(val)",
"fAndARate": "(val)",
"fedAwardProjDesc": "(val)",
"ffataRequired": "(val)",
"fsrsSubawardNumber": "(val)",
"organizationId": "(val)",
"requisitionId": "(val)",
"requisitionerId": "(val)",
"requisitionerUnit": "(val)",
"sequenceNumber": "(val)",
"siteInvestigator": "(val)",
"startDate": "(val)",
"statusCode": "(val)",
"subAwardCode": "(val)",
"subAwardId": "(val)",
"subAwardSequenceStatus": "(val)",
"subAwardTypeCode": "(val)",
"title": "(val)",
"vendorNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sub AwardsGET/subaward/api/v1/sub-awards/
Example URI
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: application/json200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"subAwardDocument.documentNumber",
"accountNumber",
"archiveLocation",
"closeoutDate",
"comments",
"costType",
"deMinimus",
"endDate",
"executionDate",
"fAndARate",
"fedAwardProjDesc",
"ffataRequired",
"fsrsSubawardNumber",
"organizationId",
"requisitionId",
"requisitionerId",
"requisitionerUnit",
"sequenceNumber",
"siteInvestigator",
"startDate",
"statusCode",
"subAwardCode",
"subAwardId",
"subAwardSequenceStatus",
"subAwardTypeCode",
"title",
"vendorNumber"
],
"primaryKey": "subAwardId"
}Get Blueprint API specification for Sub AwardsGET/subaward/api/v1/sub-awards/
Example URI
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Awards.md"
transfer-encoding: chunked