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