API Documentation

< Back

Kuali Research REST APIs - Subaward

Research Subaward ¶

Closeout Types ¶

Get Closeout Types by Key
GET`/subaward/api/v1/closeout-types/(key)`

Example URI

GET /subaward/api/v1/closeout-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "closeoutTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Closeout Types
GET`/subaward/api/v1/closeout-types/`

Example URI

GET /subaward/api/v1/closeout-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "closeoutTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "closeoutTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Closeout Types with Filtering
GET`/subaward/api/v1/closeout-types/`

Example URI

GET /subaward/api/v1/closeout-types/

URI Parameters

HideShow

closeoutTypeCode: string (optional)
Closeout Type. Maximum length is 22.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "closeoutTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "closeoutTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Closeout Types
GET`/subaward/api/v1/closeout-types/`

Example URI

GET /subaward/api/v1/closeout-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "closeoutTypeCode",
    "description"
  ],
  "primaryKey": "closeoutTypeCode"
}

Get Blueprint API specification for Closeout Types
GET`/subaward/api/v1/closeout-types/`

Example URI

GET /subaward/api/v1/closeout-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Closeout Types.md"
transfer-encoding: chunked

Update Closeout Types
PUT`/subaward/api/v1/closeout-types/(key)`

Example URI

PUT /subaward/api/v1/closeout-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "closeoutTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Closeout Types
PUT`/subaward/api/v1/closeout-types/`

Example URI

PUT /subaward/api/v1/closeout-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "closeoutTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "closeoutTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Closeout Types
PATCH`/subaward/api/v1/closeout-types/(key)`

Example URI

PATCH /subaward/api/v1/closeout-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "closeoutTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "closeoutTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Closeout Types
POST`/subaward/api/v1/closeout-types/`

Example URI

POST /subaward/api/v1/closeout-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "closeoutTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "closeoutTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Closeout Types
POST`/subaward/api/v1/closeout-types/`

Example URI

POST /subaward/api/v1/closeout-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "closeoutTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "closeoutTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "closeoutTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "closeoutTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Closeout Types by Key
DELETE`/subaward/api/v1/closeout-types/(key)`

Example URI

DELETE /subaward/api/v1/closeout-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Closeout Types
DELETE`/subaward/api/v1/closeout-types/`

Example URI

DELETE /subaward/api/v1/closeout-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Closeout Types with Matching
DELETE`/subaward/api/v1/closeout-types/`

Example URI

DELETE /subaward/api/v1/closeout-types/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Released Sub Award Amounts ¶

Get Released Sub Award Amounts by Key
GET`/subaward/api/v1/released-sub-award-amounts/(key)`

Example URI

GET /subaward/api/v1/released-sub-award-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "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
GET`/subaward/api/v1/released-sub-award-amounts/`

Example URI

GET /subaward/api/v1/released-sub-award-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Filtering
GET`/subaward/api/v1/released-sub-award-amounts/`

Example URI

GET /subaward/api/v1/released-sub-award-amounts/

URI Parameters

HideShow

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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Amounts
GET`/subaward/api/v1/released-sub-award-amounts/`

Example URI

GET /subaward/api/v1/released-sub-award-amounts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "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 Amounts
GET`/subaward/api/v1/released-sub-award-amounts/`

Example URI

GET /subaward/api/v1/released-sub-award-amounts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Released Sub Award Amounts.md"
transfer-encoding: chunked

Update Released Sub Award Amounts
PUT`/subaward/api/v1/released-sub-award-amounts/(key)`

Example URI

PUT /subaward/api/v1/released-sub-award-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "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 204

Update Multiple Released Sub Award Amounts
PUT`/subaward/api/v1/released-sub-award-amounts/`

Example URI

PUT /subaward/api/v1/released-sub-award-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 204

Update Specific Attributes Released Sub Award Amounts
PATCH`/subaward/api/v1/released-sub-award-amounts/(key)`

Example URI

PATCH /subaward/api/v1/released-sub-award-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "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 204

HideShow

Body

{
  "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 Amounts
POST`/subaward/api/v1/released-sub-award-amounts/`

Example URI

POST /subaward/api/v1/released-sub-award-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "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 201

HideShow

Body

{
  "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 Amounts
POST`/subaward/api/v1/released-sub-award-amounts/`

Example URI

POST /subaward/api/v1/released-sub-award-amounts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 201

HideShow

Body

[
  {
    "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 Key
DELETE`/subaward/api/v1/released-sub-award-amounts/(key)`

Example URI

DELETE /subaward/api/v1/released-sub-award-amounts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Released Sub Award Amounts
DELETE`/subaward/api/v1/released-sub-award-amounts/`

Example URI

DELETE /subaward/api/v1/released-sub-award-amounts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Released Sub Award Amounts with Matching
DELETE`/subaward/api/v1/released-sub-award-amounts/`

Example URI

DELETE /subaward/api/v1/released-sub-award-amounts/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Amount Infos ¶

Get Sub Award Amount Infos by Key
GET`/subaward/api/v1/sub-award-amount-infos/(key)`

Example URI

GET /subaward/api/v1/sub-award-amount-infos/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "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
GET`/subaward/api/v1/sub-award-amount-infos/`

Example URI

GET /subaward/api/v1/sub-award-amount-infos/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Filtering
GET`/subaward/api/v1/sub-award-amount-infos/`

Example URI

GET /subaward/api/v1/sub-award-amount-infos/

URI Parameters

HideShow

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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Infos
GET`/subaward/api/v1/sub-award-amount-infos/`

Example URI

GET /subaward/api/v1/sub-award-amount-infos/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "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 Infos
GET`/subaward/api/v1/sub-award-amount-infos/`

Example URI

GET /subaward/api/v1/sub-award-amount-infos/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Amount Infos.md"
transfer-encoding: chunked

Update Sub Award Amount Infos
PUT`/subaward/api/v1/sub-award-amount-infos/(key)`

Example URI

PUT /subaward/api/v1/sub-award-amount-infos/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "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 204

Update Multiple Sub Award Amount Infos
PUT`/subaward/api/v1/sub-award-amount-infos/`

Example URI

PUT /subaward/api/v1/sub-award-amount-infos/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 204

Update Specific Attributes Sub Award Amount Infos
PATCH`/subaward/api/v1/sub-award-amount-infos/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-amount-infos/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "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 204

HideShow

Body

{
  "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 Infos
POST`/subaward/api/v1/sub-award-amount-infos/`

Example URI

POST /subaward/api/v1/sub-award-amount-infos/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "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 201

HideShow

Body

{
  "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 Infos
POST`/subaward/api/v1/sub-award-amount-infos/`

Example URI

POST /subaward/api/v1/sub-award-amount-infos/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 201

HideShow

Body

[
  {
    "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 Key
DELETE`/subaward/api/v1/sub-award-amount-infos/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-amount-infos/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Amount Infos
DELETE`/subaward/api/v1/sub-award-amount-infos/`

Example URI

DELETE /subaward/api/v1/sub-award-amount-infos/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Amount Infos with Matching
DELETE`/subaward/api/v1/sub-award-amount-infos/`

Example URI

DELETE /subaward/api/v1/sub-award-amount-infos/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Approval Types ¶

Get Sub Award Approval Types by Key
GET`/subaward/api/v1/sub-award-approval-types/(key)`

Example URI

GET /subaward/api/v1/sub-award-approval-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "subAwardApprovalTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Sub Award Approval Types
GET`/subaward/api/v1/sub-award-approval-types/`

Example URI

GET /subaward/api/v1/sub-award-approval-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "subAwardApprovalTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardApprovalTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Sub Award Approval Types with Filtering
GET`/subaward/api/v1/sub-award-approval-types/`

Example URI

GET /subaward/api/v1/sub-award-approval-types/

URI Parameters

HideShow

subAwardApprovalTypeCode: string (optional)
SubAward Approval Type Code. Maximum length is 22.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "subAwardApprovalTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardApprovalTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Sub Award Approval Types
GET`/subaward/api/v1/sub-award-approval-types/`

Example URI

GET /subaward/api/v1/sub-award-approval-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "subAwardApprovalTypeCode",
    "description"
  ],
  "primaryKey": "subAwardApprovalTypeCode"
}

Get Blueprint API specification for Sub Award Approval Types
GET`/subaward/api/v1/sub-award-approval-types/`

Example URI

GET /subaward/api/v1/sub-award-approval-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Approval Types.md"
transfer-encoding: chunked

Update Sub Award Approval Types
PUT`/subaward/api/v1/sub-award-approval-types/(key)`

Example URI

PUT /subaward/api/v1/sub-award-approval-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardApprovalTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sub Award Approval Types
PUT`/subaward/api/v1/sub-award-approval-types/`

Example URI

PUT /subaward/api/v1/sub-award-approval-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "subAwardApprovalTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardApprovalTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Sub Award Approval Types
PATCH`/subaward/api/v1/sub-award-approval-types/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-approval-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardApprovalTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "subAwardApprovalTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Sub Award Approval Types
POST`/subaward/api/v1/sub-award-approval-types/`

Example URI

POST /subaward/api/v1/sub-award-approval-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardApprovalTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "subAwardApprovalTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Sub Award Approval Types
POST`/subaward/api/v1/sub-award-approval-types/`

Example URI

POST /subaward/api/v1/sub-award-approval-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "subAwardApprovalTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardApprovalTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "subAwardApprovalTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardApprovalTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Sub Award Approval Types by Key
DELETE`/subaward/api/v1/sub-award-approval-types/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-approval-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Approval Types
DELETE`/subaward/api/v1/sub-award-approval-types/`

Example URI

DELETE /subaward/api/v1/sub-award-approval-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Approval Types with Matching
DELETE`/subaward/api/v1/sub-award-approval-types/`

Example URI

DELETE /subaward/api/v1/sub-award-approval-types/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Attachment Types ¶

Get Sub Award Attachment Types by Key
GET`/subaward/api/v1/sub-award-attachment-types/(key)`

Example URI

GET /subaward/api/v1/sub-award-attachment-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "subAwardAttachmentTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Sub Award Attachment Types
GET`/subaward/api/v1/sub-award-attachment-types/`

Example URI

GET /subaward/api/v1/sub-award-attachment-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "subAwardAttachmentTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardAttachmentTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Sub Award Attachment Types with Filtering
GET`/subaward/api/v1/sub-award-attachment-types/`

Example URI

GET /subaward/api/v1/sub-award-attachment-types/

URI Parameters

HideShow

subAwardAttachmentTypeCode: string (optional)
Subaward Attachment Type Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "subAwardAttachmentTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardAttachmentTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Sub Award Attachment Types
GET`/subaward/api/v1/sub-award-attachment-types/`

Example URI

GET /subaward/api/v1/sub-award-attachment-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "subAwardAttachmentTypeCode",
    "description"
  ],
  "primaryKey": "subAwardAttachmentTypeCode"
}

Get Blueprint API specification for Sub Award Attachment Types
GET`/subaward/api/v1/sub-award-attachment-types/`

Example URI

GET /subaward/api/v1/sub-award-attachment-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Attachment Types.md"
transfer-encoding: chunked

Update Sub Award Attachment Types
PUT`/subaward/api/v1/sub-award-attachment-types/(key)`

Example URI

PUT /subaward/api/v1/sub-award-attachment-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardAttachmentTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sub Award Attachment Types
PUT`/subaward/api/v1/sub-award-attachment-types/`

Example URI

PUT /subaward/api/v1/sub-award-attachment-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "subAwardAttachmentTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardAttachmentTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Sub Award Attachment Types
PATCH`/subaward/api/v1/sub-award-attachment-types/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-attachment-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardAttachmentTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "subAwardAttachmentTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Sub Award Attachment Types
POST`/subaward/api/v1/sub-award-attachment-types/`

Example URI

POST /subaward/api/v1/sub-award-attachment-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardAttachmentTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "subAwardAttachmentTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Sub Award Attachment Types
POST`/subaward/api/v1/sub-award-attachment-types/`

Example URI

POST /subaward/api/v1/sub-award-attachment-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "subAwardAttachmentTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardAttachmentTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "subAwardAttachmentTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardAttachmentTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Sub Award Attachment Types by Key
DELETE`/subaward/api/v1/sub-award-attachment-types/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-attachment-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Attachment Types
DELETE`/subaward/api/v1/sub-award-attachment-types/`

Example URI

DELETE /subaward/api/v1/sub-award-attachment-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Attachment Types with Matching
DELETE`/subaward/api/v1/sub-award-attachment-types/`

Example URI

DELETE /subaward/api/v1/sub-award-attachment-types/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Attachments ¶

Get Sub Award Attachments by Key
GET`/subaward/api/v1/sub-award-attachments/(key)`

Example URI

GET /subaward/api/v1/sub-award-attachments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "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
GET`/subaward/api/v1/sub-award-attachments/`

Example URI

GET /subaward/api/v1/sub-award-attachments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Filtering
GET`/subaward/api/v1/sub-award-attachments/`

Example URI

GET /subaward/api/v1/sub-award-attachments/

URI Parameters

HideShow

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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Attachments
GET`/subaward/api/v1/sub-award-attachments/`

Example URI

GET /subaward/api/v1/sub-award-attachments/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "attachmentId",
    "subAwardId",
    "subAwardCode",
    "sequenceNumber",
    "subAwardAttachmentTypeCode",
    "documentId",
    "fileDataId",
    "fileName",
    "mimeType",
    "documentStatusCode",
    "description",
    "lastUpdateTimestamp",
    "lastUpdateUser"
  ],
  "primaryKey": "attachmentId"
}

Get Blueprint API specification for Sub Award Attachments
GET`/subaward/api/v1/sub-award-attachments/`

Example URI

GET /subaward/api/v1/sub-award-attachments/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Attachments.md"
transfer-encoding: chunked

Update Sub Award Attachments
PUT`/subaward/api/v1/sub-award-attachments/(key)`

Example URI

PUT /subaward/api/v1/sub-award-attachments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "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 204

Update Multiple Sub Award Attachments
PUT`/subaward/api/v1/sub-award-attachments/`

Example URI

PUT /subaward/api/v1/sub-award-attachments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 204

Update Specific Attributes Sub Award Attachments
PATCH`/subaward/api/v1/sub-award-attachments/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-attachments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "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 204

HideShow

Body

{
  "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 Attachments
POST`/subaward/api/v1/sub-award-attachments/`

Example URI

POST /subaward/api/v1/sub-award-attachments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "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 201

HideShow

Body

{
  "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 Attachments
POST`/subaward/api/v1/sub-award-attachments/`

Example URI

POST /subaward/api/v1/sub-award-attachments/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 201

HideShow

Body

[
  {
    "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 Key
DELETE`/subaward/api/v1/sub-award-attachments/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-attachments/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Attachments
DELETE`/subaward/api/v1/sub-award-attachments/`

Example URI

DELETE /subaward/api/v1/sub-award-attachments/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Attachments with Matching
DELETE`/subaward/api/v1/sub-award-attachments/`

Example URI

DELETE /subaward/api/v1/sub-award-attachments/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Closeouts ¶

Get Sub Award Closeouts by Key
GET`/subaward/api/v1/sub-award-closeouts/(key)`

Example URI

GET /subaward/api/v1/sub-award-closeouts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "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
GET`/subaward/api/v1/sub-award-closeouts/`

Example URI

GET /subaward/api/v1/sub-award-closeouts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Filtering
GET`/subaward/api/v1/sub-award-closeouts/`

Example URI

GET /subaward/api/v1/sub-award-closeouts/

URI Parameters

HideShow

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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Closeouts
GET`/subaward/api/v1/sub-award-closeouts/`

Example URI

GET /subaward/api/v1/sub-award-closeouts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "subAwardCloseoutId",
    "subAwardId",
    "sequenceNumber",
    "subAwardCode",
    "closeoutNumber",
    "closeoutTypeCode",
    "dateRequested",
    "dateFollowup",
    "dateReceived",
    "comments"
  ],
  "primaryKey": "subAwardCloseoutId"
}

Get Blueprint API specification for Sub Award Closeouts
GET`/subaward/api/v1/sub-award-closeouts/`

Example URI

GET /subaward/api/v1/sub-award-closeouts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Closeouts.md"
transfer-encoding: chunked

Update Sub Award Closeouts
PUT`/subaward/api/v1/sub-award-closeouts/(key)`

Example URI

PUT /subaward/api/v1/sub-award-closeouts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardCloseoutId": "(val)",
  "subAwardId": "(val)",
  "sequenceNumber": "(val)",
  "subAwardCode": "(val)",
  "closeoutNumber": "(val)",
  "closeoutTypeCode": "(val)",
  "dateRequested": "(val)",
  "dateFollowup": "(val)",
  "dateReceived": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sub Award Closeouts
PUT`/subaward/api/v1/sub-award-closeouts/`

Example URI

PUT /subaward/api/v1/sub-award-closeouts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 204

Update Specific Attributes Sub Award Closeouts
PATCH`/subaward/api/v1/sub-award-closeouts/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-closeouts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardCloseoutId": "(val)",
  "subAwardId": "(val)",
  "sequenceNumber": "(val)",
  "subAwardCode": "(val)",
  "closeoutNumber": "(val)",
  "closeoutTypeCode": "(val)",
  "dateRequested": "(val)",
  "dateFollowup": "(val)",
  "dateReceived": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "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 Closeouts
POST`/subaward/api/v1/sub-award-closeouts/`

Example URI

POST /subaward/api/v1/sub-award-closeouts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardCloseoutId": "(val)",
  "subAwardId": "(val)",
  "sequenceNumber": "(val)",
  "subAwardCode": "(val)",
  "closeoutNumber": "(val)",
  "closeoutTypeCode": "(val)",
  "dateRequested": "(val)",
  "dateFollowup": "(val)",
  "dateReceived": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "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 Closeouts
POST`/subaward/api/v1/sub-award-closeouts/`

Example URI

POST /subaward/api/v1/sub-award-closeouts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 201

HideShow

Body

[
  {
    "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 Key
DELETE`/subaward/api/v1/sub-award-closeouts/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-closeouts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Closeouts
DELETE`/subaward/api/v1/sub-award-closeouts/`

Example URI

DELETE /subaward/api/v1/sub-award-closeouts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Closeouts with Matching
DELETE`/subaward/api/v1/sub-award-closeouts/`

Example URI

DELETE /subaward/api/v1/sub-award-closeouts/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Contacts ¶

Get Sub Award Contacts by Key
GET`/subaward/api/v1/sub-award-contacts/(key)`

Example URI

GET /subaward/api/v1/sub-award-contacts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "subAwardContactId": "(val)",
  "subAwardId": "(val)",
  "sequenceNumber": "(val)",
  "subAwardCode": "(val)",
  "contactTypeCode": "(val)",
  "rolodexId": "(val)",
  "_primaryKey": "(val)"
}

Get All Sub Award Contacts
GET`/subaward/api/v1/sub-award-contacts/`

Example URI

GET /subaward/api/v1/sub-award-contacts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Filtering
GET`/subaward/api/v1/sub-award-contacts/`

Example URI

GET /subaward/api/v1/sub-award-contacts/

URI Parameters

HideShow

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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Contacts
GET`/subaward/api/v1/sub-award-contacts/`

Example URI

GET /subaward/api/v1/sub-award-contacts/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "subAwardContactId",
    "subAwardId",
    "sequenceNumber",
    "subAwardCode",
    "contactTypeCode",
    "rolodexId"
  ],
  "primaryKey": "subAwardContactId"
}

Get Blueprint API specification for Sub Award Contacts
GET`/subaward/api/v1/sub-award-contacts/`

Example URI

GET /subaward/api/v1/sub-award-contacts/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Contacts.md"
transfer-encoding: chunked

Update Sub Award Contacts
PUT`/subaward/api/v1/sub-award-contacts/(key)`

Example URI

PUT /subaward/api/v1/sub-award-contacts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardContactId": "(val)",
  "subAwardId": "(val)",
  "sequenceNumber": "(val)",
  "subAwardCode": "(val)",
  "contactTypeCode": "(val)",
  "rolodexId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sub Award Contacts
PUT`/subaward/api/v1/sub-award-contacts/`

Example URI

PUT /subaward/api/v1/sub-award-contacts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 204

Update Specific Attributes Sub Award Contacts
PATCH`/subaward/api/v1/sub-award-contacts/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-contacts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardContactId": "(val)",
  "subAwardId": "(val)",
  "sequenceNumber": "(val)",
  "subAwardCode": "(val)",
  "contactTypeCode": "(val)",
  "rolodexId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "subAwardContactId": "(val)",
  "subAwardId": "(val)",
  "sequenceNumber": "(val)",
  "subAwardCode": "(val)",
  "contactTypeCode": "(val)",
  "rolodexId": "(val)",
  "_primaryKey": "(val)"
}

Insert Sub Award Contacts
POST`/subaward/api/v1/sub-award-contacts/`

Example URI

POST /subaward/api/v1/sub-award-contacts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardContactId": "(val)",
  "subAwardId": "(val)",
  "sequenceNumber": "(val)",
  "subAwardCode": "(val)",
  "contactTypeCode": "(val)",
  "rolodexId": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "subAwardContactId": "(val)",
  "subAwardId": "(val)",
  "sequenceNumber": "(val)",
  "subAwardCode": "(val)",
  "contactTypeCode": "(val)",
  "rolodexId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Sub Award Contacts
POST`/subaward/api/v1/sub-award-contacts/`

Example URI

POST /subaward/api/v1/sub-award-contacts/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 201

HideShow

Body

[
  {
    "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 Key
DELETE`/subaward/api/v1/sub-award-contacts/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-contacts/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Contacts
DELETE`/subaward/api/v1/sub-award-contacts/`

Example URI

DELETE /subaward/api/v1/sub-award-contacts/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Contacts with Matching
DELETE`/subaward/api/v1/sub-award-contacts/`

Example URI

DELETE /subaward/api/v1/sub-award-contacts/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Copyright Types ¶

Get Sub Award Copyright Types by Key
GET`/subaward/api/v1/sub-award-copyright-types/(key)`

Example URI

GET /subaward/api/v1/sub-award-copyright-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "copyRightTypeCode": "(val)",
  "copyRightTypeDescription": "(val)",
  "_primaryKey": "(val)"
}

Get All Sub Award Copyright Types
GET`/subaward/api/v1/sub-award-copyright-types/`

Example URI

GET /subaward/api/v1/sub-award-copyright-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "copyRightTypeCode": "(val)",
    "copyRightTypeDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "copyRightTypeCode": "(val)",
    "copyRightTypeDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Sub Award Copyright Types with Filtering
GET`/subaward/api/v1/sub-award-copyright-types/`

Example URI

GET /subaward/api/v1/sub-award-copyright-types/

URI Parameters

HideShow

copyRightTypeCode: string (optional)
CopyRightTypeCode. Maximum length is 60.
copyRightTypeDescription: string (optional)
copyRightTypeDescription. Maximum length is 60.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "copyRightTypeCode": "(val)",
    "copyRightTypeDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "copyRightTypeCode": "(val)",
    "copyRightTypeDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Sub Award Copyright Types
GET`/subaward/api/v1/sub-award-copyright-types/`

Example URI

GET /subaward/api/v1/sub-award-copyright-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "copyRightTypeCode",
    "copyRightTypeDescription"
  ],
  "primaryKey": "copyRightTypeCode"
}

Get Blueprint API specification for Sub Award Copyright Types
GET`/subaward/api/v1/sub-award-copyright-types/`

Example URI

GET /subaward/api/v1/sub-award-copyright-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Copyright Types.md"
transfer-encoding: chunked

Update Sub Award Copyright Types
PUT`/subaward/api/v1/sub-award-copyright-types/(key)`

Example URI

PUT /subaward/api/v1/sub-award-copyright-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "copyRightTypeCode": "(val)",
  "copyRightTypeDescription": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sub Award Copyright Types
PUT`/subaward/api/v1/sub-award-copyright-types/`

Example URI

PUT /subaward/api/v1/sub-award-copyright-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "copyRightTypeCode": "(val)",
    "copyRightTypeDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "copyRightTypeCode": "(val)",
    "copyRightTypeDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Sub Award Copyright Types
PATCH`/subaward/api/v1/sub-award-copyright-types/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-copyright-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "copyRightTypeCode": "(val)",
  "copyRightTypeDescription": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "copyRightTypeCode": "(val)",
  "copyRightTypeDescription": "(val)",
  "_primaryKey": "(val)"
}

Insert Sub Award Copyright Types
POST`/subaward/api/v1/sub-award-copyright-types/`

Example URI

POST /subaward/api/v1/sub-award-copyright-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "copyRightTypeCode": "(val)",
  "copyRightTypeDescription": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "copyRightTypeCode": "(val)",
  "copyRightTypeDescription": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Sub Award Copyright Types
POST`/subaward/api/v1/sub-award-copyright-types/`

Example URI

POST /subaward/api/v1/sub-award-copyright-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "copyRightTypeCode": "(val)",
    "copyRightTypeDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "copyRightTypeCode": "(val)",
    "copyRightTypeDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "copyRightTypeCode": "(val)",
    "copyRightTypeDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "copyRightTypeCode": "(val)",
    "copyRightTypeDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Sub Award Copyright Types by Key
DELETE`/subaward/api/v1/sub-award-copyright-types/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-copyright-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Copyright Types
DELETE`/subaward/api/v1/sub-award-copyright-types/`

Example URI

DELETE /subaward/api/v1/sub-award-copyright-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Copyright Types with Matching
DELETE`/subaward/api/v1/sub-award-copyright-types/`

Example URI

DELETE /subaward/api/v1/sub-award-copyright-types/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Cost Types ¶

Get Sub Award Cost Types by Key
GET`/subaward/api/v1/sub-award-cost-types/(key)`

Example URI

GET /subaward/api/v1/sub-award-cost-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "costTypeCode": "(val)",
  "costTypeDescription": "(val)",
  "_primaryKey": "(val)"
}

Get All Sub Award Cost Types
GET`/subaward/api/v1/sub-award-cost-types/`

Example URI

GET /subaward/api/v1/sub-award-cost-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "costTypeCode": "(val)",
    "costTypeDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "costTypeCode": "(val)",
    "costTypeDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Sub Award Cost Types with Filtering
GET`/subaward/api/v1/sub-award-cost-types/`

Example URI

GET /subaward/api/v1/sub-award-cost-types/

URI Parameters

HideShow

costTypeCode: string (optional)
CostTypeCode. Maximum length is 60.
costTypeDescription: string (optional)
CostTypeDescription. Maximum length is 60.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "costTypeCode": "(val)",
    "costTypeDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "costTypeCode": "(val)",
    "costTypeDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Sub Award Cost Types
GET`/subaward/api/v1/sub-award-cost-types/`

Example URI

GET /subaward/api/v1/sub-award-cost-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "costTypeCode",
    "costTypeDescription"
  ],
  "primaryKey": "costTypeCode"
}

Get Blueprint API specification for Sub Award Cost Types
GET`/subaward/api/v1/sub-award-cost-types/`

Example URI

GET /subaward/api/v1/sub-award-cost-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Cost Types.md"
transfer-encoding: chunked

Update Sub Award Cost Types
PUT`/subaward/api/v1/sub-award-cost-types/(key)`

Example URI

PUT /subaward/api/v1/sub-award-cost-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "costTypeCode": "(val)",
  "costTypeDescription": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sub Award Cost Types
PUT`/subaward/api/v1/sub-award-cost-types/`

Example URI

PUT /subaward/api/v1/sub-award-cost-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "costTypeCode": "(val)",
    "costTypeDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "costTypeCode": "(val)",
    "costTypeDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Sub Award Cost Types
PATCH`/subaward/api/v1/sub-award-cost-types/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-cost-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "costTypeCode": "(val)",
  "costTypeDescription": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "costTypeCode": "(val)",
  "costTypeDescription": "(val)",
  "_primaryKey": "(val)"
}

Insert Sub Award Cost Types
POST`/subaward/api/v1/sub-award-cost-types/`

Example URI

POST /subaward/api/v1/sub-award-cost-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "costTypeCode": "(val)",
  "costTypeDescription": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "costTypeCode": "(val)",
  "costTypeDescription": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Sub Award Cost Types
POST`/subaward/api/v1/sub-award-cost-types/`

Example URI

POST /subaward/api/v1/sub-award-cost-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "costTypeCode": "(val)",
    "costTypeDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "costTypeCode": "(val)",
    "costTypeDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "costTypeCode": "(val)",
    "costTypeDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "costTypeCode": "(val)",
    "costTypeDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Sub Award Cost Types by Key
DELETE`/subaward/api/v1/sub-award-cost-types/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-cost-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Cost Types
DELETE`/subaward/api/v1/sub-award-cost-types/`

Example URI

DELETE /subaward/api/v1/sub-award-cost-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Cost Types with Matching
DELETE`/subaward/api/v1/sub-award-cost-types/`

Example URI

DELETE /subaward/api/v1/sub-award-cost-types/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Custom Data ¶

Get Sub Award Custom Data by Key
GET`/subaward/api/v1/sub-award-custom-data/(key)`

Example URI

GET /subaward/api/v1/sub-award-custom-data/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "subAwardCustomDataId": "(val)",
  "sequenceNumber": "(val)",
  "subAwardCode": "(val)",
  "customAttributeId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Get All Sub Award Custom Data
GET`/subaward/api/v1/sub-award-custom-data/`

Example URI

GET /subaward/api/v1/sub-award-custom-data/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Filtering
GET`/subaward/api/v1/sub-award-custom-data/`

Example URI

GET /subaward/api/v1/sub-award-custom-data/

URI Parameters

HideShow

subAwardCustomDataId: string (optional)
sequenceNumber: string (optional)
subAwardCode: string (optional)
customAttributeId: string (optional)
value: string (optional)
Value. Maximum length is 2000.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Data
GET`/subaward/api/v1/sub-award-custom-data/`

Example URI

GET /subaward/api/v1/sub-award-custom-data/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "subAwardCustomDataId",
    "sequenceNumber",
    "subAwardCode",
    "customAttributeId",
    "value"
  ],
  "primaryKey": "subAwardCustomDataId"
}

Get Blueprint API specification for Sub Award Custom Data
GET`/subaward/api/v1/sub-award-custom-data/`

Example URI

GET /subaward/api/v1/sub-award-custom-data/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Custom Data.md"
transfer-encoding: chunked

Sub Award Forms ¶

Get Sub Award Forms by Key
GET`/subaward/api/v1/sub-award-forms/(key)`

Example URI

GET /subaward/api/v1/sub-award-forms/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "formId": "(val)",
  "description": "(val)",
  "attachmentContent": "(val)",
  "fileName": "(val)",
  "contentType": "(val)",
  "templateTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Sub Award Forms
GET`/subaward/api/v1/sub-award-forms/`

Example URI

GET /subaward/api/v1/sub-award-forms/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Filtering
GET`/subaward/api/v1/sub-award-forms/`

Example URI

GET /subaward/api/v1/sub-award-forms/

URI Parameters

HideShow

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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Forms
GET`/subaward/api/v1/sub-award-forms/`

Example URI

GET /subaward/api/v1/sub-award-forms/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "formId",
    "description",
    "attachmentContent",
    "fileName",
    "contentType",
    "templateTypeCode"
  ],
  "primaryKey": "formId"
}

Get Blueprint API specification for Sub Award Forms
GET`/subaward/api/v1/sub-award-forms/`

Example URI

GET /subaward/api/v1/sub-award-forms/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Forms.md"
transfer-encoding: chunked

Update Sub Award Forms
PUT`/subaward/api/v1/sub-award-forms/(key)`

Example URI

PUT /subaward/api/v1/sub-award-forms/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "formId": "(val)",
  "description": "(val)",
  "attachmentContent": "(val)",
  "fileName": "(val)",
  "contentType": "(val)",
  "templateTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sub Award Forms
PUT`/subaward/api/v1/sub-award-forms/`

Example URI

PUT /subaward/api/v1/sub-award-forms/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 204

Update Specific Attributes Sub Award Forms
PATCH`/subaward/api/v1/sub-award-forms/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-forms/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "formId": "(val)",
  "description": "(val)",
  "attachmentContent": "(val)",
  "fileName": "(val)",
  "contentType": "(val)",
  "templateTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "formId": "(val)",
  "description": "(val)",
  "attachmentContent": "(val)",
  "fileName": "(val)",
  "contentType": "(val)",
  "templateTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Sub Award Forms
POST`/subaward/api/v1/sub-award-forms/`

Example URI

POST /subaward/api/v1/sub-award-forms/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "formId": "(val)",
  "description": "(val)",
  "attachmentContent": "(val)",
  "fileName": "(val)",
  "contentType": "(val)",
  "templateTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "formId": "(val)",
  "description": "(val)",
  "attachmentContent": "(val)",
  "fileName": "(val)",
  "contentType": "(val)",
  "templateTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Sub Award Forms
POST`/subaward/api/v1/sub-award-forms/`

Example URI

POST /subaward/api/v1/sub-award-forms/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 201

HideShow

Body

[
  {
    "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 Key
DELETE`/subaward/api/v1/sub-award-forms/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-forms/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Forms
DELETE`/subaward/api/v1/sub-award-forms/`

Example URI

DELETE /subaward/api/v1/sub-award-forms/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Forms with Matching
DELETE`/subaward/api/v1/sub-award-forms/`

Example URI

DELETE /subaward/api/v1/sub-award-forms/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Funding Sources ¶

Get Sub Award Funding Sources by Key
GET`/subaward/api/v1/sub-award-funding-sources/(key)`

Example URI

GET /subaward/api/v1/sub-award-funding-sources/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "subAwardFundingSourceId": "(val)",
  "subAwardId": "(val)",
  "subAwardCode": "(val)",
  "sequenceNumber": "(val)",
  "awardId": "(val)",
  "_primaryKey": "(val)"
}

Get All Sub Award Funding Sources
GET`/subaward/api/v1/sub-award-funding-sources/`

Example URI

GET /subaward/api/v1/sub-award-funding-sources/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Filtering
GET`/subaward/api/v1/sub-award-funding-sources/`

Example URI

GET /subaward/api/v1/sub-award-funding-sources/

URI Parameters

HideShow

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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Sources
GET`/subaward/api/v1/sub-award-funding-sources/`

Example URI

GET /subaward/api/v1/sub-award-funding-sources/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "subAwardFundingSourceId",
    "subAwardId",
    "subAwardCode",
    "sequenceNumber",
    "awardId"
  ],
  "primaryKey": "subAwardFundingSourceId"
}

Get Blueprint API specification for Sub Award Funding Sources
GET`/subaward/api/v1/sub-award-funding-sources/`

Example URI

GET /subaward/api/v1/sub-award-funding-sources/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Funding Sources.md"
transfer-encoding: chunked

Update Sub Award Funding Sources
PUT`/subaward/api/v1/sub-award-funding-sources/(key)`

Example URI

PUT /subaward/api/v1/sub-award-funding-sources/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardFundingSourceId": "(val)",
  "subAwardId": "(val)",
  "subAwardCode": "(val)",
  "sequenceNumber": "(val)",
  "awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sub Award Funding Sources
PUT`/subaward/api/v1/sub-award-funding-sources/`

Example URI

PUT /subaward/api/v1/sub-award-funding-sources/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 204

Update Specific Attributes Sub Award Funding Sources
PATCH`/subaward/api/v1/sub-award-funding-sources/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-funding-sources/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardFundingSourceId": "(val)",
  "subAwardId": "(val)",
  "subAwardCode": "(val)",
  "sequenceNumber": "(val)",
  "awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "subAwardFundingSourceId": "(val)",
  "subAwardId": "(val)",
  "subAwardCode": "(val)",
  "sequenceNumber": "(val)",
  "awardId": "(val)",
  "_primaryKey": "(val)"
}

Insert Sub Award Funding Sources
POST`/subaward/api/v1/sub-award-funding-sources/`

Example URI

POST /subaward/api/v1/sub-award-funding-sources/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardFundingSourceId": "(val)",
  "subAwardId": "(val)",
  "subAwardCode": "(val)",
  "sequenceNumber": "(val)",
  "awardId": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "subAwardFundingSourceId": "(val)",
  "subAwardId": "(val)",
  "subAwardCode": "(val)",
  "sequenceNumber": "(val)",
  "awardId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Sub Award Funding Sources
POST`/subaward/api/v1/sub-award-funding-sources/`

Example URI

POST /subaward/api/v1/sub-award-funding-sources/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 201

HideShow

Body

[
  {
    "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 Key
DELETE`/subaward/api/v1/sub-award-funding-sources/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-funding-sources/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Funding Sources
DELETE`/subaward/api/v1/sub-award-funding-sources/`

Example URI

DELETE /subaward/api/v1/sub-award-funding-sources/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Funding Sources with Matching
DELETE`/subaward/api/v1/sub-award-funding-sources/`

Example URI

DELETE /subaward/api/v1/sub-award-funding-sources/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Person Mass Changes ¶

Get Sub Award Person Mass Changes by Key
GET`/subaward/api/v1/sub-award-person-mass-changes/(key)`

Example URI

GET /subaward/api/v1/sub-award-person-mass-changes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "subawardPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "requisitioner": "(val)",
  "contact": "(val)",
  "_primaryKey": "(val)"
}

Get All Sub Award Person Mass Changes
GET`/subaward/api/v1/sub-award-person-mass-changes/`

Example URI

GET /subaward/api/v1/sub-award-person-mass-changes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Filtering
GET`/subaward/api/v1/sub-award-person-mass-changes/`

Example URI

GET /subaward/api/v1/sub-award-person-mass-changes/

URI Parameters

HideShow

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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Changes
GET`/subaward/api/v1/sub-award-person-mass-changes/`

Example URI

GET /subaward/api/v1/sub-award-person-mass-changes/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "subawardPersonMassChangeId",
    "personMassChangeId",
    "requisitioner",
    "contact"
  ],
  "primaryKey": "subawardPersonMassChangeId"
}

Get Blueprint API specification for Sub Award Person Mass Changes
GET`/subaward/api/v1/sub-award-person-mass-changes/`

Example URI

GET /subaward/api/v1/sub-award-person-mass-changes/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Person Mass Changes.md"
transfer-encoding: chunked

Update Sub Award Person Mass Changes
PUT`/subaward/api/v1/sub-award-person-mass-changes/(key)`

Example URI

PUT /subaward/api/v1/sub-award-person-mass-changes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subawardPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "requisitioner": "(val)",
  "contact": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sub Award Person Mass Changes
PUT`/subaward/api/v1/sub-award-person-mass-changes/`

Example URI

PUT /subaward/api/v1/sub-award-person-mass-changes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "subawardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "requisitioner": "(val)",
    "contact": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subawardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "requisitioner": "(val)",
    "contact": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Sub Award Person Mass Changes
PATCH`/subaward/api/v1/sub-award-person-mass-changes/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-person-mass-changes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subawardPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "requisitioner": "(val)",
  "contact": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "subawardPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "requisitioner": "(val)",
  "contact": "(val)",
  "_primaryKey": "(val)"
}

Insert Sub Award Person Mass Changes
POST`/subaward/api/v1/sub-award-person-mass-changes/`

Example URI

POST /subaward/api/v1/sub-award-person-mass-changes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subawardPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "requisitioner": "(val)",
  "contact": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "subawardPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "requisitioner": "(val)",
  "contact": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Sub Award Person Mass Changes
POST`/subaward/api/v1/sub-award-person-mass-changes/`

Example URI

POST /subaward/api/v1/sub-award-person-mass-changes/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "subawardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "requisitioner": "(val)",
    "contact": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subawardPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "requisitioner": "(val)",
    "contact": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "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 Key
DELETE`/subaward/api/v1/sub-award-person-mass-changes/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-person-mass-changes/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Person Mass Changes
DELETE`/subaward/api/v1/sub-award-person-mass-changes/`

Example URI

DELETE /subaward/api/v1/sub-award-person-mass-changes/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Person Mass Changes with Matching
DELETE`/subaward/api/v1/sub-award-person-mass-changes/`

Example URI

DELETE /subaward/api/v1/sub-award-person-mass-changes/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Report Types ¶

Get Sub Award Report Types by Key
GET`/subaward/api/v1/sub-award-report-types/(key)`

Example URI

GET /subaward/api/v1/sub-award-report-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "subAwardReportTypeCode": "(val)",
  "description": "(val)",
  "sortId": "(val)",
  "_primaryKey": "(val)"
}

Get All Sub Award Report Types
GET`/subaward/api/v1/sub-award-report-types/`

Example URI

GET /subaward/api/v1/sub-award-report-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "subAwardReportTypeCode": "(val)",
    "description": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardReportTypeCode": "(val)",
    "description": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Sub Award Report Types with Filtering
GET`/subaward/api/v1/sub-award-report-types/`

Example URI

GET /subaward/api/v1/sub-award-report-types/

URI Parameters

HideShow

subAwardReportTypeCode: string (optional)
Report Type Code. Maximum length is 3.
description: string (optional)
Description. Maximum length is 200.
sortId: string (optional)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "subAwardReportTypeCode": "(val)",
    "description": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardReportTypeCode": "(val)",
    "description": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Sub Award Report Types
GET`/subaward/api/v1/sub-award-report-types/`

Example URI

GET /subaward/api/v1/sub-award-report-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "subAwardReportTypeCode",
    "description",
    "sortId"
  ],
  "primaryKey": "subAwardReportTypeCode"
}

Get Blueprint API specification for Sub Award Report Types
GET`/subaward/api/v1/sub-award-report-types/`

Example URI

GET /subaward/api/v1/sub-award-report-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Report Types.md"
transfer-encoding: chunked

Update Sub Award Report Types
PUT`/subaward/api/v1/sub-award-report-types/(key)`

Example URI

PUT /subaward/api/v1/sub-award-report-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardReportTypeCode": "(val)",
  "description": "(val)",
  "sortId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sub Award Report Types
PUT`/subaward/api/v1/sub-award-report-types/`

Example URI

PUT /subaward/api/v1/sub-award-report-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "subAwardReportTypeCode": "(val)",
    "description": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardReportTypeCode": "(val)",
    "description": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Sub Award Report Types
PATCH`/subaward/api/v1/sub-award-report-types/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-report-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardReportTypeCode": "(val)",
  "description": "(val)",
  "sortId": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "subAwardReportTypeCode": "(val)",
  "description": "(val)",
  "sortId": "(val)",
  "_primaryKey": "(val)"
}

Insert Sub Award Report Types
POST`/subaward/api/v1/sub-award-report-types/`

Example URI

POST /subaward/api/v1/sub-award-report-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardReportTypeCode": "(val)",
  "description": "(val)",
  "sortId": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "subAwardReportTypeCode": "(val)",
  "description": "(val)",
  "sortId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Sub Award Report Types
POST`/subaward/api/v1/sub-award-report-types/`

Example URI

POST /subaward/api/v1/sub-award-report-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "subAwardReportTypeCode": "(val)",
    "description": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardReportTypeCode": "(val)",
    "description": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "subAwardReportTypeCode": "(val)",
    "description": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardReportTypeCode": "(val)",
    "description": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Sub Award Report Types by Key
DELETE`/subaward/api/v1/sub-award-report-types/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-report-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Report Types
DELETE`/subaward/api/v1/sub-award-report-types/`

Example URI

DELETE /subaward/api/v1/sub-award-report-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Report Types with Matching
DELETE`/subaward/api/v1/sub-award-report-types/`

Example URI

DELETE /subaward/api/v1/sub-award-report-types/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Reports ¶

Get Sub Award Reports by Key
GET`/subaward/api/v1/sub-award-reports/(key)`

Example URI

GET /subaward/api/v1/sub-award-reports/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "subAwardReportId": "(val)",
  "subAwardId": "(val)",
  "subAwardCode": "(val)",
  "sequenceNumber": "(val)",
  "subAwardReportTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Sub Award Reports
GET`/subaward/api/v1/sub-award-reports/`

Example URI

GET /subaward/api/v1/sub-award-reports/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Filtering
GET`/subaward/api/v1/sub-award-reports/`

Example URI

GET /subaward/api/v1/sub-award-reports/

URI Parameters

HideShow

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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Reports
GET`/subaward/api/v1/sub-award-reports/`

Example URI

GET /subaward/api/v1/sub-award-reports/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "subAwardReportId",
    "subAwardId",
    "subAwardCode",
    "sequenceNumber",
    "subAwardReportTypeCode"
  ],
  "primaryKey": "subAwardReportId"
}

Get Blueprint API specification for Sub Award Reports
GET`/subaward/api/v1/sub-award-reports/`

Example URI

GET /subaward/api/v1/sub-award-reports/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Reports.md"
transfer-encoding: chunked

Update Sub Award Reports
PUT`/subaward/api/v1/sub-award-reports/(key)`

Example URI

PUT /subaward/api/v1/sub-award-reports/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardReportId": "(val)",
  "subAwardId": "(val)",
  "subAwardCode": "(val)",
  "sequenceNumber": "(val)",
  "subAwardReportTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sub Award Reports
PUT`/subaward/api/v1/sub-award-reports/`

Example URI

PUT /subaward/api/v1/sub-award-reports/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 204

Update Specific Attributes Sub Award Reports
PATCH`/subaward/api/v1/sub-award-reports/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-reports/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardReportId": "(val)",
  "subAwardId": "(val)",
  "subAwardCode": "(val)",
  "sequenceNumber": "(val)",
  "subAwardReportTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "subAwardReportId": "(val)",
  "subAwardId": "(val)",
  "subAwardCode": "(val)",
  "sequenceNumber": "(val)",
  "subAwardReportTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Sub Award Reports
POST`/subaward/api/v1/sub-award-reports/`

Example URI

POST /subaward/api/v1/sub-award-reports/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardReportId": "(val)",
  "subAwardId": "(val)",
  "subAwardCode": "(val)",
  "sequenceNumber": "(val)",
  "subAwardReportTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "subAwardReportId": "(val)",
  "subAwardId": "(val)",
  "subAwardCode": "(val)",
  "sequenceNumber": "(val)",
  "subAwardReportTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Sub Award Reports
POST`/subaward/api/v1/sub-award-reports/`

Example URI

POST /subaward/api/v1/sub-award-reports/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 201

HideShow

Body

[
  {
    "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 Key
DELETE`/subaward/api/v1/sub-award-reports/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-reports/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Reports
DELETE`/subaward/api/v1/sub-award-reports/`

Example URI

DELETE /subaward/api/v1/sub-award-reports/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Reports with Matching
DELETE`/subaward/api/v1/sub-award-reports/`

Example URI

DELETE /subaward/api/v1/sub-award-reports/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Statuses ¶

Get Sub Award Statuses by Key
GET`/subaward/api/v1/sub-award-statuses/(key)`

Example URI

GET /subaward/api/v1/sub-award-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "subAwardStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Sub Award Statuses
GET`/subaward/api/v1/sub-award-statuses/`

Example URI

GET /subaward/api/v1/sub-award-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "subAwardStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Sub Award Statuses with Filtering
GET`/subaward/api/v1/sub-award-statuses/`

Example URI

GET /subaward/api/v1/sub-award-statuses/

URI Parameters

HideShow

subAwardStatusCode: string (optional)
Subaward Status Code. Maximum length is 22.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "subAwardStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Sub Award Statuses
GET`/subaward/api/v1/sub-award-statuses/`

Example URI

GET /subaward/api/v1/sub-award-statuses/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "subAwardStatusCode",
    "description"
  ],
  "primaryKey": "subAwardStatusCode"
}

Get Blueprint API specification for Sub Award Statuses
GET`/subaward/api/v1/sub-award-statuses/`

Example URI

GET /subaward/api/v1/sub-award-statuses/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Statuses.md"
transfer-encoding: chunked

Update Sub Award Statuses
PUT`/subaward/api/v1/sub-award-statuses/(key)`

Example URI

PUT /subaward/api/v1/sub-award-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sub Award Statuses
PUT`/subaward/api/v1/sub-award-statuses/`

Example URI

PUT /subaward/api/v1/sub-award-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "subAwardStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Sub Award Statuses
PATCH`/subaward/api/v1/sub-award-statuses/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "subAwardStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Sub Award Statuses
POST`/subaward/api/v1/sub-award-statuses/`

Example URI

POST /subaward/api/v1/sub-award-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "subAwardStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "subAwardStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Sub Award Statuses
POST`/subaward/api/v1/sub-award-statuses/`

Example URI

POST /subaward/api/v1/sub-award-statuses/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "subAwardStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "subAwardStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "subAwardStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Sub Award Statuses by Key
DELETE`/subaward/api/v1/sub-award-statuses/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-statuses/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Statuses
DELETE`/subaward/api/v1/sub-award-statuses/`

Example URI

DELETE /subaward/api/v1/sub-award-statuses/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Statuses with Matching
DELETE`/subaward/api/v1/sub-award-statuses/`

Example URI

DELETE /subaward/api/v1/sub-award-statuses/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Template Infos ¶

Get Sub Award Template Infos by Key
GET`/subaward/api/v1/sub-award-template-infos/(key)`

Example URI

GET /subaward/api/v1/sub-award-template-infos/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "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
GET`/subaward/api/v1/sub-award-template-infos/`

Example URI

GET /subaward/api/v1/sub-award-template-infos/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Filtering
GET`/subaward/api/v1/sub-award-template-infos/`

Example URI

GET /subaward/api/v1/sub-award-template-infos/

URI Parameters

HideShow

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)
subRegisteredInCcr: string (optional)
Sub Registered in CCR?. Maximum length is 1.
subExemptFromReportingComp: string (optional)
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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Infos
GET`/subaward/api/v1/sub-award-template-infos/`

Example URI

GET /subaward/api/v1/sub-award-template-infos/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "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 Infos
GET`/subaward/api/v1/sub-award-template-infos/`

Example URI

GET /subaward/api/v1/sub-award-template-infos/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Template Infos.md"
transfer-encoding: chunked

Update Sub Award Template Infos
PUT`/subaward/api/v1/sub-award-template-infos/(key)`

Example URI

PUT /subaward/api/v1/sub-award-template-infos/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "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 204

Update Multiple Sub Award Template Infos
PUT`/subaward/api/v1/sub-award-template-infos/`

Example URI

PUT /subaward/api/v1/sub-award-template-infos/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 204

Update Specific Attributes Sub Award Template Infos
PATCH`/subaward/api/v1/sub-award-template-infos/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-template-infos/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "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 204

HideShow

Body

{
  "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 Infos
POST`/subaward/api/v1/sub-award-template-infos/`

Example URI

POST /subaward/api/v1/sub-award-template-infos/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "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 201

HideShow

Body

{
  "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 Infos
POST`/subaward/api/v1/sub-award-template-infos/`

Example URI

POST /subaward/api/v1/sub-award-template-infos/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "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 201

HideShow

Body

[
  {
    "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 Key
DELETE`/subaward/api/v1/sub-award-template-infos/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-template-infos/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Template Infos
DELETE`/subaward/api/v1/sub-award-template-infos/`

Example URI

DELETE /subaward/api/v1/sub-award-template-infos/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Template Infos with Matching
DELETE`/subaward/api/v1/sub-award-template-infos/`

Example URI

DELETE /subaward/api/v1/sub-award-template-infos/

URI Parameters

HideShow

_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)
subRegisteredInCcr: string (optional)
Sub Registered in CCR?. Maximum length is 1.
subExemptFromReportingComp: string (optional)
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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Award Template Types ¶

Get Sub Award Template Types by Key
GET`/subaward/api/v1/sub-award-template-types/(key)`

Example URI

GET /subaward/api/v1/sub-award-template-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "templateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Sub Award Template Types
GET`/subaward/api/v1/sub-award-template-types/`

Example URI

GET /subaward/api/v1/sub-award-template-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "templateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Sub Award Template Types with Filtering
GET`/subaward/api/v1/sub-award-template-types/`

Example URI

GET /subaward/api/v1/sub-award-template-types/

URI Parameters

HideShow

templateTypeCode: string (optional)
Subaward Template Type Code. Maximum length is 22.
description: string (optional)
Description. Maximum length is 200.

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "templateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Sub Award Template Types
GET`/subaward/api/v1/sub-award-template-types/`

Example URI

GET /subaward/api/v1/sub-award-template-types/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "columns": [
    "templateTypeCode",
    "description"
  ],
  "primaryKey": "templateTypeCode"
}

Get Blueprint API specification for Sub Award Template Types
GET`/subaward/api/v1/sub-award-template-types/`

Example URI

GET /subaward/api/v1/sub-award-template-types/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Award Template Types.md"
transfer-encoding: chunked

Update Sub Award Template Types
PUT`/subaward/api/v1/sub-award-template-types/(key)`

Example URI

PUT /subaward/api/v1/sub-award-template-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "templateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

Update Multiple Sub Award Template Types
PUT`/subaward/api/v1/sub-award-template-types/`

Example URI

PUT /subaward/api/v1/sub-award-template-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "templateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 204

Update Specific Attributes Sub Award Template Types
PATCH`/subaward/api/v1/sub-award-template-types/(key)`

Example URI

PATCH /subaward/api/v1/sub-award-template-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "templateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 204

HideShow

Body

{
  "templateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Sub Award Template Types
POST`/subaward/api/v1/sub-award-template-types/`

Example URI

POST /subaward/api/v1/sub-award-template-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

{
  "templateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Response 201

HideShow

Body

{
  "templateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Sub Award Template Types
POST`/subaward/api/v1/sub-award-template-types/`

Example URI

POST /subaward/api/v1/sub-award-template-types/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Body

[
  {
    "templateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Response 201

HideShow

Body

[
  {
    "templateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "templateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Sub Award Template Types by Key
DELETE`/subaward/api/v1/sub-award-template-types/(key)`

Example URI

DELETE /subaward/api/v1/sub-award-template-types/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Template Types
DELETE`/subaward/api/v1/sub-award-template-types/`

Example URI

DELETE /subaward/api/v1/sub-award-template-types/

URI Parameters

HideShow

_allowMulti: boolean (required)
flag to allow multiple resources to be deleted in one operation

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Delete All Sub Award Template Types with Matching
DELETE`/subaward/api/v1/sub-award-template-types/`

Example URI

DELETE /subaward/api/v1/sub-award-template-types/

URI Parameters

HideShow

_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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 204

Sub Awards ¶

Get Sub Awards by Key
GET`/subaward/api/v1/sub-awards/(key)`

Example URI

GET /subaward/api/v1/sub-awards/(key)

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "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
GET`/subaward/api/v1/sub-awards/`

Example URI

GET /subaward/api/v1/sub-awards/

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Filtering
GET`/subaward/api/v1/sub-awards/`

Example URI

GET /subaward/api/v1/sub-awards/

URI Parameters

HideShow

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

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

[
  {
    "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 Awards
GET`/subaward/api/v1/sub-awards/`

Example URI

GET /subaward/api/v1/sub-awards/

URI Parameters

HideShow

_schema: string (required)
will instruct the endpoint to return a schema data structure for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: application/json

Response 200

HideShow

Headers

Content-Type: application/json;charset=UTF-8

Body

{
  "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 Awards
GET`/subaward/api/v1/sub-awards/`

Example URI

GET /subaward/api/v1/sub-awards/

URI Parameters

HideShow

_blueprint: string (required)
will instruct the endpoint to return an api blueprint markdown file for the resource

Request

HideShow

Headers

Authorization: Bearer {api-key}
Content-Type: text/markdown

Response 200

HideShow

Headers

Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sub Awards.md"
transfer-encoding: chunked

Kuali Research REST APIs - Subaward ¶

Research Subaward ¶

Closeout Types ¶

Get Closeout Types by KeyGET/subaward/api/v1/closeout-types/(key)

Example URI

Headers

Headers

Body

Get All Closeout TypesGET/subaward/api/v1/closeout-types/

Example URI

Headers

Headers

Body

Get All Closeout Types with FilteringGET/subaward/api/v1/closeout-types/

Example URI

Headers

Headers

Body

Get Schema for Closeout TypesGET/subaward/api/v1/closeout-types/

Example URI

Headers

Headers

Body

Get Blueprint API specification for Closeout TypesGET/subaward/api/v1/closeout-types/

Example URI

Headers

Headers

Update Closeout TypesPUT/subaward/api/v1/closeout-types/(key)

Example URI

Headers

Body

Update Multiple Closeout TypesPUT/subaward/api/v1/closeout-types/

Example URI

Headers

Body

Update Specific Attributes Closeout TypesPATCH/subaward/api/v1/closeout-types/(key)

Example URI

Headers

Body

Body

Insert Closeout TypesPOST/subaward/api/v1/closeout-types/

Example URI

Headers

Body

Body

Insert Multiple Closeout TypesPOST/subaward/api/v1/closeout-types/

Example URI

Headers

Body

Body

Delete Closeout Types by KeyDELETE/subaward/api/v1/closeout-types/(key)

Example URI

Headers

Delete All Closeout TypesDELETE/subaward/api/v1/closeout-types/

Example URI

Headers

Delete All Closeout Types with MatchingDELETE/subaward/api/v1/closeout-types/

Example URI

Headers

Released Sub Award Amounts ¶

Get Released Sub Award Amounts by KeyGET/subaward/api/v1/released-sub-award-amounts/(key)

Example URI

Headers

Headers

Body

Get All Released Sub Award AmountsGET/subaward/api/v1/released-sub-award-amounts/

Example URI

Headers

Headers

Body

Get All Released Sub Award Amounts with FilteringGET/subaward/api/v1/released-sub-award-amounts/

Example URI

Headers

Headers

Body

Get Schema for Released Sub Award AmountsGET/subaward/api/v1/released-sub-award-amounts/

Example URI

Headers

Headers

Body

Kuali Research REST APIs - Subaward

Get Closeout Types by Key
GET`/subaward/api/v1/closeout-types/(key)`

Get All Closeout Types
GET`/subaward/api/v1/closeout-types/`

Get All Closeout Types with Filtering
GET`/subaward/api/v1/closeout-types/`

Get Schema for Closeout Types
GET`/subaward/api/v1/closeout-types/`

Get Blueprint API specification for Closeout Types
GET`/subaward/api/v1/closeout-types/`

Update Closeout Types
PUT`/subaward/api/v1/closeout-types/(key)`

Update Multiple Closeout Types
PUT`/subaward/api/v1/closeout-types/`

Update Specific Attributes Closeout Types
PATCH`/subaward/api/v1/closeout-types/(key)`

Insert Closeout Types
POST`/subaward/api/v1/closeout-types/`

Insert Multiple Closeout Types
POST`/subaward/api/v1/closeout-types/`

Delete Closeout Types by Key
DELETE`/subaward/api/v1/closeout-types/(key)`

Delete All Closeout Types
DELETE`/subaward/api/v1/closeout-types/`

Delete All Closeout Types with Matching
DELETE`/subaward/api/v1/closeout-types/`

Get Released Sub Award Amounts by Key
GET`/subaward/api/v1/released-sub-award-amounts/(key)`

Get All Released Sub Award Amounts
GET`/subaward/api/v1/released-sub-award-amounts/`

Get All Released Sub Award Amounts with Filtering
GET`/subaward/api/v1/released-sub-award-amounts/`

Get Schema for Released Sub Award Amounts
GET`/subaward/api/v1/released-sub-award-amounts/`

Get Blueprint API specification for Released Sub Award Amounts
GET`/subaward/api/v1/released-sub-award-amounts/`

Update Released Sub Award Amounts
PUT`/subaward/api/v1/released-sub-award-amounts/(key)`

Update Multiple Released Sub Award Amounts
PUT`/subaward/api/v1/released-sub-award-amounts/`

Update Specific Attributes Released Sub Award Amounts
PATCH`/subaward/api/v1/released-sub-award-amounts/(key)`

Insert Released Sub Award Amounts
POST`/subaward/api/v1/released-sub-award-amounts/`

Insert Multiple Released Sub Award Amounts
POST`/subaward/api/v1/released-sub-award-amounts/`

Delete Released Sub Award Amounts by Key
DELETE`/subaward/api/v1/released-sub-award-amounts/(key)`

Delete All Released Sub Award Amounts
DELETE`/subaward/api/v1/released-sub-award-amounts/`

Delete All Released Sub Award Amounts with Matching
DELETE`/subaward/api/v1/released-sub-award-amounts/`

Get Sub Award Amount Infos by Key
GET`/subaward/api/v1/sub-award-amount-infos/(key)`

Get All Sub Award Amount Infos
GET`/subaward/api/v1/sub-award-amount-infos/`

Get All Sub Award Amount Infos with Filtering
GET`/subaward/api/v1/sub-award-amount-infos/`

Get Schema for Sub Award Amount Infos
GET`/subaward/api/v1/sub-award-amount-infos/`

Get Blueprint API specification for Sub Award Amount Infos
GET`/subaward/api/v1/sub-award-amount-infos/`

Update Sub Award Amount Infos
PUT`/subaward/api/v1/sub-award-amount-infos/(key)`

Update Multiple Sub Award Amount Infos
PUT`/subaward/api/v1/sub-award-amount-infos/`