API Documentation
Kuali Research REST APIs - Proposal Development
Research Proposal Development ¶
Abstract Types ¶
Get Abstract Types by KeyGET/propdev/api/v1/abstract-types/(key)
Example URI
GET /propdev/api/v1/abstract-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Abstract TypesGET/propdev/api/v1/abstract-types/
Example URI
GET /propdev/api/v1/abstract-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Abstract Types with FilteringGET/propdev/api/v1/abstract-types/
Example URI
GET /propdev/api/v1/abstract-types/
URI Parameters
- code
string(optional)Abstract Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Abstract TypesGET/propdev/api/v1/abstract-types/
Example URI
GET /propdev/api/v1/abstract-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Abstract TypesGET/propdev/api/v1/abstract-types/
Example URI
GET /propdev/api/v1/abstract-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Abstract Types.md"
transfer-encoding: chunkedUpdate Abstract TypesPUT/propdev/api/v1/abstract-types/(key)
Example URI
PUT /propdev/api/v1/abstract-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Abstract TypesPUT/propdev/api/v1/abstract-types/
Example URI
PUT /propdev/api/v1/abstract-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Abstract TypesPATCH/propdev/api/v1/abstract-types/(key)
Example URI
PATCH /propdev/api/v1/abstract-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Abstract TypesPOST/propdev/api/v1/abstract-types/
Example URI
POST /propdev/api/v1/abstract-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Abstract TypesPOST/propdev/api/v1/abstract-types/
Example URI
POST /propdev/api/v1/abstract-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Abstract Types by KeyDELETE/propdev/api/v1/abstract-types/(key)
Example URI
DELETE /propdev/api/v1/abstract-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Abstract TypesDELETE/propdev/api/v1/abstract-types/
Example URI
DELETE /propdev/api/v1/abstract-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Abstract Types with MatchingDELETE/propdev/api/v1/abstract-types/
Example URI
DELETE /propdev/api/v1/abstract-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Abstract Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Changed Data ¶
Get Budget Changed Data by KeyGET/propdev/api/v1/budget-changed-data/(key)
Example URI
GET /propdev/api/v1/budget-changed-data/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}Get All Budget Changed DataGET/propdev/api/v1/budget-changed-data/
Example URI
GET /propdev/api/v1/budget-changed-data/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
},
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Changed Data with FilteringGET/propdev/api/v1/budget-changed-data/
Example URI
GET /propdev/api/v1/budget-changed-data/
URI Parameters
- changeNumber
string(optional)Change Number. Maximum length is 3.
- columnName
string(optional)Field. Maximum length is 30.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8.
- changedValue
string(optional)Changed Value. Maximum length is 200.
- comments
string(optional)Comments. Maximum length is 300.
- displayValue
string(optional)Display Value. Maximum length is 200.
- oldDisplayValue
string(optional)Old Display Value. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
},
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Changed DataGET/propdev/api/v1/budget-changed-data/
Example URI
GET /propdev/api/v1/budget-changed-data/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"changeNumber",
"columnName",
"proposalNumber",
"changedValue",
"comments",
"displayValue",
"oldDisplayValue"
],
"primaryKey": "changeNumber:columnName:proposalNumber"
}Get Blueprint API specification for Budget Changed DataGET/propdev/api/v1/budget-changed-data/
Example URI
GET /propdev/api/v1/budget-changed-data/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Changed Data.md"
transfer-encoding: chunkedUpdate Budget Changed DataPUT/propdev/api/v1/budget-changed-data/(key)
Example URI
PUT /propdev/api/v1/budget-changed-data/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Changed DataPUT/propdev/api/v1/budget-changed-data/
Example URI
PUT /propdev/api/v1/budget-changed-data/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
},
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Changed DataPATCH/propdev/api/v1/budget-changed-data/(key)
Example URI
PATCH /propdev/api/v1/budget-changed-data/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}Insert Budget Changed DataPOST/propdev/api/v1/budget-changed-data/
Example URI
POST /propdev/api/v1/budget-changed-data/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Changed DataPOST/propdev/api/v1/budget-changed-data/
Example URI
POST /propdev/api/v1/budget-changed-data/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
},
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
},
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Changed Data by KeyDELETE/propdev/api/v1/budget-changed-data/(key)
Example URI
DELETE /propdev/api/v1/budget-changed-data/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Changed DataDELETE/propdev/api/v1/budget-changed-data/
Example URI
DELETE /propdev/api/v1/budget-changed-data/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Changed Data with MatchingDELETE/propdev/api/v1/budget-changed-data/
Example URI
DELETE /propdev/api/v1/budget-changed-data/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- changeNumber
string(optional)Change Number. Maximum length is 3.
- columnName
string(optional)Field. Maximum length is 30.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8.
- changedValue
string(optional)Changed Value. Maximum length is 200.
- comments
string(optional)Comments. Maximum length is 300.
- displayValue
string(optional)Display Value. Maximum length is 200.
- oldDisplayValue
string(optional)Old Display Value. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Columns To Alter ¶
Get Budget Columns To Alter by KeyGET/propdev/api/v1/budget-columns-to-alter/(key)
Example URI
GET /propdev/api/v1/budget-columns-to-alter/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}Get All Budget Columns To AlterGET/propdev/api/v1/budget-columns-to-alter/
Example URI
GET /propdev/api/v1/budget-columns-to-alter/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
},
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Columns To Alter with FilteringGET/propdev/api/v1/budget-columns-to-alter/
Example URI
GET /propdev/api/v1/budget-columns-to-alter/
URI Parameters
- columnName
string(optional)Column Name. Maximum length is 30.
- columnLabel
string(optional)Column Label. Maximum length is 30.
- dataLength
string(optional)Data Length. Maximum length is 4.
- dataType
string(optional)Data Type. Maximum length is 9.
- hasLookup
string(optional)Has Lookup. Maximum length is 1.
- lookupClass
string(optional)Lookup Argument. Maximum length is 100.
- lookupReturn
string(optional)Lookup Return. Maximum length is 50.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
},
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Columns To AlterGET/propdev/api/v1/budget-columns-to-alter/
Example URI
GET /propdev/api/v1/budget-columns-to-alter/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"columnName",
"columnLabel",
"dataLength",
"dataType",
"hasLookup",
"lookupClass",
"lookupReturn"
],
"primaryKey": "columnName"
}Get Blueprint API specification for Budget Columns To AlterGET/propdev/api/v1/budget-columns-to-alter/
Example URI
GET /propdev/api/v1/budget-columns-to-alter/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Columns To Alter.md"
transfer-encoding: chunkedUpdate Budget Columns To AlterPUT/propdev/api/v1/budget-columns-to-alter/(key)
Example URI
PUT /propdev/api/v1/budget-columns-to-alter/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Columns To AlterPUT/propdev/api/v1/budget-columns-to-alter/
Example URI
PUT /propdev/api/v1/budget-columns-to-alter/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
},
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Columns To AlterPATCH/propdev/api/v1/budget-columns-to-alter/(key)
Example URI
PATCH /propdev/api/v1/budget-columns-to-alter/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}Insert Budget Columns To AlterPOST/propdev/api/v1/budget-columns-to-alter/
Example URI
POST /propdev/api/v1/budget-columns-to-alter/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Columns To AlterPOST/propdev/api/v1/budget-columns-to-alter/
Example URI
POST /propdev/api/v1/budget-columns-to-alter/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
},
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
},
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Columns To Alter by KeyDELETE/propdev/api/v1/budget-columns-to-alter/(key)
Example URI
DELETE /propdev/api/v1/budget-columns-to-alter/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Columns To AlterDELETE/propdev/api/v1/budget-columns-to-alter/
Example URI
DELETE /propdev/api/v1/budget-columns-to-alter/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Columns To Alter with MatchingDELETE/propdev/api/v1/budget-columns-to-alter/
Example URI
DELETE /propdev/api/v1/budget-columns-to-alter/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- columnName
string(optional)Column Name. Maximum length is 30.
- columnLabel
string(optional)Column Label. Maximum length is 30.
- dataLength
string(optional)Data Length. Maximum length is 4.
- dataType
string(optional)Data Type. Maximum length is 9.
- hasLookup
string(optional)Has Lookup. Maximum length is 1.
- lookupClass
string(optional)Lookup Argument. Maximum length is 100.
- lookupReturn
string(optional)Lookup Return. Maximum length is 50.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Statuses ¶
Get Budget Statuses by KeyGET/propdev/api/v1/budget-statuses/(key)
Example URI
GET /propdev/api/v1/budget-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Budget StatusesGET/propdev/api/v1/budget-statuses/
Example URI
GET /propdev/api/v1/budget-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Statuses with FilteringGET/propdev/api/v1/budget-statuses/
Example URI
GET /propdev/api/v1/budget-statuses/
URI Parameters
- budgetStatusCode
string(optional)Budget Status Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget StatusesGET/propdev/api/v1/budget-statuses/
Example URI
GET /propdev/api/v1/budget-statuses/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetStatusCode",
"description"
],
"primaryKey": "budgetStatusCode"
}Get Blueprint API specification for Budget StatusesGET/propdev/api/v1/budget-statuses/
Example URI
GET /propdev/api/v1/budget-statuses/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Statuses.md"
transfer-encoding: chunkedUpdate Budget StatusesPUT/propdev/api/v1/budget-statuses/(key)
Example URI
PUT /propdev/api/v1/budget-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget StatusesPUT/propdev/api/v1/budget-statuses/
Example URI
PUT /propdev/api/v1/budget-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget StatusesPATCH/propdev/api/v1/budget-statuses/(key)
Example URI
PATCH /propdev/api/v1/budget-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Budget StatusesPOST/propdev/api/v1/budget-statuses/
Example URI
POST /propdev/api/v1/budget-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget StatusesPOST/propdev/api/v1/budget-statuses/
Example URI
POST /propdev/api/v1/budget-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Statuses by KeyDELETE/propdev/api/v1/budget-statuses/(key)
Example URI
DELETE /propdev/api/v1/budget-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget StatusesDELETE/propdev/api/v1/budget-statuses/
Example URI
DELETE /propdev/api/v1/budget-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Statuses with MatchingDELETE/propdev/api/v1/budget-statuses/
Example URI
DELETE /propdev/api/v1/budget-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- budgetStatusCode
string(optional)Budget Status Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Sub Award Attachments ¶
Get Budget Sub Award Attachments by KeyGET/propdev/api/v1/budget-sub-award-attachments/(key)
Example URI
GET /propdev/api/v1/budget-sub-award-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
}Get All Budget Sub Award AttachmentsGET/propdev/api/v1/budget-sub-award-attachments/
Example URI
GET /propdev/api/v1/budget-sub-award-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
},
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Sub Award Attachments with FilteringGET/propdev/api/v1/budget-sub-award-attachments/
Example URI
GET /propdev/api/v1/budget-sub-award-attachments/
URI Parameters
- data
string(optional)- name
string(optional)- type
string(optional)- id
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
},
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Sub Award AttachmentsGET/propdev/api/v1/budget-sub-award-attachments/
Example URI
GET /propdev/api/v1/budget-sub-award-attachments/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"data",
"name",
"type",
"id"
],
"primaryKey": "id"
}Get Blueprint API specification for Budget Sub Award AttachmentsGET/propdev/api/v1/budget-sub-award-attachments/
Example URI
GET /propdev/api/v1/budget-sub-award-attachments/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Sub Award Attachments.md"
transfer-encoding: chunkedUpdate Budget Sub Award AttachmentsPUT/propdev/api/v1/budget-sub-award-attachments/(key)
Example URI
PUT /propdev/api/v1/budget-sub-award-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Sub Award AttachmentsPUT/propdev/api/v1/budget-sub-award-attachments/
Example URI
PUT /propdev/api/v1/budget-sub-award-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
},
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Sub Award AttachmentsPATCH/propdev/api/v1/budget-sub-award-attachments/(key)
Example URI
PATCH /propdev/api/v1/budget-sub-award-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
}Insert Budget Sub Award AttachmentsPOST/propdev/api/v1/budget-sub-award-attachments/
Example URI
POST /propdev/api/v1/budget-sub-award-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Sub Award AttachmentsPOST/propdev/api/v1/budget-sub-award-attachments/
Example URI
POST /propdev/api/v1/budget-sub-award-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
},
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
},
{
"data": "(val)",
"name": "(val)",
"type": "(val)",
"id": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Sub Award Attachments by KeyDELETE/propdev/api/v1/budget-sub-award-attachments/(key)
Example URI
DELETE /propdev/api/v1/budget-sub-award-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Sub Award AttachmentsDELETE/propdev/api/v1/budget-sub-award-attachments/
Example URI
DELETE /propdev/api/v1/budget-sub-award-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Sub Award Attachments with MatchingDELETE/propdev/api/v1/budget-sub-award-attachments/
Example URI
DELETE /propdev/api/v1/budget-sub-award-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- data
string(optional)- name
string(optional)- type
string(optional)- id
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Sub Award Files ¶
Get Budget Sub Award Files by KeyGET/propdev/api/v1/budget-sub-award-files/(key)
Example URI
GET /propdev/api/v1/budget-sub-award-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
}Get All Budget Sub Award FilesGET/propdev/api/v1/budget-sub-award-files/
Example URI
GET /propdev/api/v1/budget-sub-award-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
},
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Sub Award Files with FilteringGET/propdev/api/v1/budget-sub-award-files/
Example URI
GET /propdev/api/v1/budget-sub-award-files/
URI Parameters
- subAwardXfdFileData
string(optional)Sub Award Xfd File Data.
- subAwardXfdFileName
string(optional)Sub Award Xfd File Name.
- subAwardXmlFileData
string(optional)Sub Award Xml File Data.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
},
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Sub Award FilesGET/propdev/api/v1/budget-sub-award-files/
Example URI
GET /propdev/api/v1/budget-sub-award-files/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"subAwardXfdFileData",
"subAwardXfdFileName",
"subAwardXmlFileData"
],
"primaryKey": "budgetSubAward"
}Get Blueprint API specification for Budget Sub Award FilesGET/propdev/api/v1/budget-sub-award-files/
Example URI
GET /propdev/api/v1/budget-sub-award-files/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Sub Award Files.md"
transfer-encoding: chunkedUpdate Budget Sub Award FilesPUT/propdev/api/v1/budget-sub-award-files/(key)
Example URI
PUT /propdev/api/v1/budget-sub-award-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Sub Award FilesPUT/propdev/api/v1/budget-sub-award-files/
Example URI
PUT /propdev/api/v1/budget-sub-award-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
},
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Sub Award FilesPATCH/propdev/api/v1/budget-sub-award-files/(key)
Example URI
PATCH /propdev/api/v1/budget-sub-award-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
}Insert Budget Sub Award FilesPOST/propdev/api/v1/budget-sub-award-files/
Example URI
POST /propdev/api/v1/budget-sub-award-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Sub Award FilesPOST/propdev/api/v1/budget-sub-award-files/
Example URI
POST /propdev/api/v1/budget-sub-award-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
},
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
},
{
"subAwardXfdFileData": "(val)",
"subAwardXfdFileName": "(val)",
"subAwardXmlFileData": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Sub Award Files by KeyDELETE/propdev/api/v1/budget-sub-award-files/(key)
Example URI
DELETE /propdev/api/v1/budget-sub-award-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Sub Award FilesDELETE/propdev/api/v1/budget-sub-award-files/
Example URI
DELETE /propdev/api/v1/budget-sub-award-files/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Sub Award Files with MatchingDELETE/propdev/api/v1/budget-sub-award-files/
Example URI
DELETE /propdev/api/v1/budget-sub-award-files/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- subAwardXfdFileData
string(optional)Sub Award Xfd File Data.
- subAwardXfdFileName
string(optional)Sub Award Xfd File Name.
- subAwardXmlFileData
string(optional)Sub Award Xml File Data.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Sub Award Period Details ¶
Get Budget Sub Award Period Details by KeyGET/propdev/api/v1/budget-sub-award-period-details/(key)
Example URI
GET /propdev/api/v1/budget-sub-award-period-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
}Get All Budget Sub Award Period DetailsGET/propdev/api/v1/budget-sub-award-period-details/
Example URI
GET /propdev/api/v1/budget-sub-award-period-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Sub Award Period Details with FilteringGET/propdev/api/v1/budget-sub-award-period-details/
Example URI
GET /propdev/api/v1/budget-sub-award-period-details/
URI Parameters
- id
string(optional)id. Maximum length is 3.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- directCost
string(optional)Direct Cost. Maximum length is 15.
- indirectCost
string(optional)F&A Cost. Maximum length is 15.
- costShare
string(optional)Cost Sharing. Maximum length is 15.
- totalCost
string(optional)Total Cost. Maximum length is 15.
- subAwardNumber
string(optional)subAwardNumber. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Sub Award Period DetailsGET/propdev/api/v1/budget-sub-award-period-details/
Example URI
GET /propdev/api/v1/budget-sub-award-period-details/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"budgetPeriod",
"directCost",
"indirectCost",
"costShare",
"totalCost",
"subAwardNumber"
],
"primaryKey": "id"
}Get Blueprint API specification for Budget Sub Award Period DetailsGET/propdev/api/v1/budget-sub-award-period-details/
Example URI
GET /propdev/api/v1/budget-sub-award-period-details/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Sub Award Period Details.md"
transfer-encoding: chunkedUpdate Budget Sub Award Period DetailsPUT/propdev/api/v1/budget-sub-award-period-details/(key)
Example URI
PUT /propdev/api/v1/budget-sub-award-period-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Sub Award Period DetailsPUT/propdev/api/v1/budget-sub-award-period-details/
Example URI
PUT /propdev/api/v1/budget-sub-award-period-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Sub Award Period DetailsPATCH/propdev/api/v1/budget-sub-award-period-details/(key)
Example URI
PATCH /propdev/api/v1/budget-sub-award-period-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
}Insert Budget Sub Award Period DetailsPOST/propdev/api/v1/budget-sub-award-period-details/
Example URI
POST /propdev/api/v1/budget-sub-award-period-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Sub Award Period DetailsPOST/propdev/api/v1/budget-sub-award-period-details/
Example URI
POST /propdev/api/v1/budget-sub-award-period-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"budgetPeriod": "(val)",
"directCost": "(val)",
"indirectCost": "(val)",
"costShare": "(val)",
"totalCost": "(val)",
"subAwardNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Sub Award Period Details by KeyDELETE/propdev/api/v1/budget-sub-award-period-details/(key)
Example URI
DELETE /propdev/api/v1/budget-sub-award-period-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Sub Award Period DetailsDELETE/propdev/api/v1/budget-sub-award-period-details/
Example URI
DELETE /propdev/api/v1/budget-sub-award-period-details/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Sub Award Period Details with MatchingDELETE/propdev/api/v1/budget-sub-award-period-details/
Example URI
DELETE /propdev/api/v1/budget-sub-award-period-details/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)id. Maximum length is 3.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- directCost
string(optional)Direct Cost. Maximum length is 15.
- indirectCost
string(optional)F&A Cost. Maximum length is 15.
- costShare
string(optional)Cost Sharing. Maximum length is 15.
- totalCost
string(optional)Total Cost. Maximum length is 15.
- subAwardNumber
string(optional)subAwardNumber. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Sub Awards ¶
Get Budget Sub Awards by KeyGET/propdev/api/v1/budget-sub-awards/(key)
Example URI
GET /propdev/api/v1/budget-sub-awards/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Get All Budget Sub AwardsGET/propdev/api/v1/budget-sub-awards/
Example URI
GET /propdev/api/v1/budget-sub-awards/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Sub Awards with FilteringGET/propdev/api/v1/budget-sub-awards/
Example URI
GET /propdev/api/v1/budget-sub-awards/
URI Parameters
- budgetId
string(optional)Budget Id.
- subAwardNumber
string(optional)subAwardNumber. Maximum length is 3.
- comments
string(optional)Comments. Maximum length is 2000.
- organizationId
string(optional)Organization Id. Maximum length is 8.
- subAwardStatusCode
string(optional)Subaward Status Code. Maximum length is 3.
- fileDataId
string(optional)File Data Id.
- subAwardXfdFileName
string(optional)Subaward PDF File Name. Maximum length is 256.
- xmlDataId
string(optional)Xml Data Id.
- translationComments
string(optional)Translation Comments. Maximum length is 2000.
- xfdUpdateTimestamp
string(optional)This attribute should always be overriden on the descriptive elements. Maximum length is 21.
- xfdUpdateUser
string(optional)xfdUpdateUser. Maximum length is 60.
- xmlUpdateTimestamp
string(optional)This attribute should always be overriden on the descriptive elements. Maximum length is 21.
- xmlUpdateUser
string(optional)xmlUpdateUser. Maximum length is 60.
- namespace
string(optional)Namespace. Maximum length is 200.
- formName
string(optional)Form Name. Maximum length is 100.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Sub AwardsGET/propdev/api/v1/budget-sub-awards/
Example URI
GET /propdev/api/v1/budget-sub-awards/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetId",
"subAwardNumber",
"comments",
"organizationId",
"subAwardStatusCode",
"fileDataId",
"subAwardXfdFileName",
"xmlDataId",
"translationComments",
"xfdUpdateTimestamp",
"xfdUpdateUser",
"xmlUpdateTimestamp",
"xmlUpdateUser",
"namespace",
"formName",
"hierarchyProposalNumber",
"hiddenInHierarchy"
],
"primaryKey": "budget:subAwardNumber"
}Get Blueprint API specification for Budget Sub AwardsGET/propdev/api/v1/budget-sub-awards/
Example URI
GET /propdev/api/v1/budget-sub-awards/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Sub Awards.md"
transfer-encoding: chunkedUpdate Budget Sub AwardsPUT/propdev/api/v1/budget-sub-awards/(key)
Example URI
PUT /propdev/api/v1/budget-sub-awards/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Sub AwardsPUT/propdev/api/v1/budget-sub-awards/
Example URI
PUT /propdev/api/v1/budget-sub-awards/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Sub AwardsPATCH/propdev/api/v1/budget-sub-awards/(key)
Example URI
PATCH /propdev/api/v1/budget-sub-awards/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert Budget Sub AwardsPOST/propdev/api/v1/budget-sub-awards/
Example URI
POST /propdev/api/v1/budget-sub-awards/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Sub AwardsPOST/propdev/api/v1/budget-sub-awards/
Example URI
POST /propdev/api/v1/budget-sub-awards/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"budgetId": "(val)",
"subAwardNumber": "(val)",
"comments": "(val)",
"organizationId": "(val)",
"subAwardStatusCode": "(val)",
"fileDataId": "(val)",
"subAwardXfdFileName": "(val)",
"xmlDataId": "(val)",
"translationComments": "(val)",
"xfdUpdateTimestamp": "(val)",
"xfdUpdateUser": "(val)",
"xmlUpdateTimestamp": "(val)",
"xmlUpdateUser": "(val)",
"namespace": "(val)",
"formName": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Sub Awards by KeyDELETE/propdev/api/v1/budget-sub-awards/(key)
Example URI
DELETE /propdev/api/v1/budget-sub-awards/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Sub AwardsDELETE/propdev/api/v1/budget-sub-awards/
Example URI
DELETE /propdev/api/v1/budget-sub-awards/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Sub Awards with MatchingDELETE/propdev/api/v1/budget-sub-awards/
Example URI
DELETE /propdev/api/v1/budget-sub-awards/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- budgetId
string(optional)Budget Id.
- subAwardNumber
string(optional)subAwardNumber. Maximum length is 3.
- comments
string(optional)Comments. Maximum length is 2000.
- organizationId
string(optional)Organization Id. Maximum length is 8.
- subAwardStatusCode
string(optional)Subaward Status Code. Maximum length is 3.
- fileDataId
string(optional)File Data Id.
- subAwardXfdFileName
string(optional)Subaward PDF File Name. Maximum length is 256.
- xmlDataId
string(optional)Xml Data Id.
- translationComments
string(optional)Translation Comments. Maximum length is 2000.
- xfdUpdateTimestamp
string(optional)This attribute should always be overriden on the descriptive elements. Maximum length is 21.
- xfdUpdateUser
string(optional)xfdUpdateUser. Maximum length is 60.
- xmlUpdateTimestamp
string(optional)This attribute should always be overriden on the descriptive elements. Maximum length is 21.
- xmlUpdateUser
string(optional)xmlUpdateUser. Maximum length is 60.
- namespace
string(optional)Namespace. Maximum length is 200.
- formName
string(optional)Form Name. Maximum length is 100.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Congressional Districts ¶
Get Congressional Districts by KeyGET/propdev/api/v1/congressional-districts/(key)
Example URI
GET /propdev/api/v1/congressional-districts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
}Get All Congressional DistrictsGET/propdev/api/v1/congressional-districts/
Example URI
GET /propdev/api/v1/congressional-districts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
}
]Get All Congressional Districts with FilteringGET/propdev/api/v1/congressional-districts/
Example URI
GET /propdev/api/v1/congressional-districts/
URI Parameters
- id
string(optional)Id.
- congressionalDistrict
string(optional)State code plus congressional district number. Maximum length is 50.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Congressional DistrictsGET/propdev/api/v1/congressional-districts/
Example URI
GET /propdev/api/v1/congressional-districts/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"congressionalDistrict"
],
"primaryKey": "id"
}Get Blueprint API specification for Congressional DistrictsGET/propdev/api/v1/congressional-districts/
Example URI
GET /propdev/api/v1/congressional-districts/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Congressional Districts.md"
transfer-encoding: chunkedUpdate Congressional DistrictsPUT/propdev/api/v1/congressional-districts/(key)
Example URI
PUT /propdev/api/v1/congressional-districts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Congressional DistrictsPUT/propdev/api/v1/congressional-districts/
Example URI
PUT /propdev/api/v1/congressional-districts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Congressional DistrictsPATCH/propdev/api/v1/congressional-districts/(key)
Example URI
PATCH /propdev/api/v1/congressional-districts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
}Insert Congressional DistrictsPOST/propdev/api/v1/congressional-districts/
Example URI
POST /propdev/api/v1/congressional-districts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Congressional DistrictsPOST/propdev/api/v1/congressional-districts/
Example URI
POST /propdev/api/v1/congressional-districts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"congressionalDistrict": "(val)",
"_primaryKey": "(val)"
}
]Delete Congressional Districts by KeyDELETE/propdev/api/v1/congressional-districts/(key)
Example URI
DELETE /propdev/api/v1/congressional-districts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Congressional DistrictsDELETE/propdev/api/v1/congressional-districts/
Example URI
DELETE /propdev/api/v1/congressional-districts/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Congressional Districts with MatchingDELETE/propdev/api/v1/congressional-districts/
Example URI
DELETE /propdev/api/v1/congressional-districts/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Id.
- congressionalDistrict
string(optional)State code plus congressional district number. Maximum length is 50.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Development Proposals ¶
Get Development Proposals by KeyGET/propdev/api/v1/development-proposals/(key)
Example URI
GET /propdev/api/v1/development-proposals/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"continuedFrom": "(val)",
"sponsorCode": "(val)",
"activityTypeCode": "(val)",
"ownedByUnitNumber": "(val)",
"requestedStartDateInitial": "(val)",
"requestedEndDateInitial": "(val)",
"title": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"noticeOfOpportunityCode": "(val)",
"deadlineType": "(val)",
"anticipatedAwardTypeCode": "(val)",
"cfdaNumber": "(val)",
"programAnnouncementNumber": "(val)",
"primeSponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"nsfSequenceNumber": "(val)",
"subcontracts": "(val)",
"agencyDivisionCode": "(val)",
"agencyProgramCode": "(val)",
"programAnnouncementTitle": "(val)",
"mailBy": "(val)",
"mailType": "(val)",
"mailAccountNumber": "(val)",
"mailDescription": "(val)",
"mailingAddressId": "(val)",
"numberOfCopies": "(val)",
"proposalStateTypeCode": "(val)",
"creationStatusCode": "(val)",
"submitFlag": "(val)",
"hierarchyStatus": "(val)",
"hierarchyOriginatingChildProposalNumber": "(val)",
"hierarchyParentProposalNumber": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"hierarchyBudgetType": "(val)",
"proposalNumberForGG": "(val)",
"opportunityIdForGG": "(val)",
"agencyRoutingIdentifier": "(val)",
"prevGrantsGovTrackingID": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Get All Development ProposalsGET/propdev/api/v1/development-proposals/
Example URI
GET /propdev/api/v1/development-proposals/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"continuedFrom": "(val)",
"sponsorCode": "(val)",
"activityTypeCode": "(val)",
"ownedByUnitNumber": "(val)",
"requestedStartDateInitial": "(val)",
"requestedEndDateInitial": "(val)",
"title": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"noticeOfOpportunityCode": "(val)",
"deadlineType": "(val)",
"anticipatedAwardTypeCode": "(val)",
"cfdaNumber": "(val)",
"programAnnouncementNumber": "(val)",
"primeSponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"nsfSequenceNumber": "(val)",
"subcontracts": "(val)",
"agencyDivisionCode": "(val)",
"agencyProgramCode": "(val)",
"programAnnouncementTitle": "(val)",
"mailBy": "(val)",
"mailType": "(val)",
"mailAccountNumber": "(val)",
"mailDescription": "(val)",
"mailingAddressId": "(val)",
"numberOfCopies": "(val)",
"proposalStateTypeCode": "(val)",
"creationStatusCode": "(val)",
"submitFlag": "(val)",
"hierarchyStatus": "(val)",
"hierarchyOriginatingChildProposalNumber": "(val)",
"hierarchyParentProposalNumber": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"hierarchyBudgetType": "(val)",
"proposalNumberForGG": "(val)",
"opportunityIdForGG": "(val)",
"agencyRoutingIdentifier": "(val)",
"prevGrantsGovTrackingID": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"continuedFrom": "(val)",
"sponsorCode": "(val)",
"activityTypeCode": "(val)",
"ownedByUnitNumber": "(val)",
"requestedStartDateInitial": "(val)",
"requestedEndDateInitial": "(val)",
"title": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"noticeOfOpportunityCode": "(val)",
"deadlineType": "(val)",
"anticipatedAwardTypeCode": "(val)",
"cfdaNumber": "(val)",
"programAnnouncementNumber": "(val)",
"primeSponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"nsfSequenceNumber": "(val)",
"subcontracts": "(val)",
"agencyDivisionCode": "(val)",
"agencyProgramCode": "(val)",
"programAnnouncementTitle": "(val)",
"mailBy": "(val)",
"mailType": "(val)",
"mailAccountNumber": "(val)",
"mailDescription": "(val)",
"mailingAddressId": "(val)",
"numberOfCopies": "(val)",
"proposalStateTypeCode": "(val)",
"creationStatusCode": "(val)",
"submitFlag": "(val)",
"hierarchyStatus": "(val)",
"hierarchyOriginatingChildProposalNumber": "(val)",
"hierarchyParentProposalNumber": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"hierarchyBudgetType": "(val)",
"proposalNumberForGG": "(val)",
"opportunityIdForGG": "(val)",
"agencyRoutingIdentifier": "(val)",
"prevGrantsGovTrackingID": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Get All Development Proposals with FilteringGET/propdev/api/v1/development-proposals/
Example URI
GET /propdev/api/v1/development-proposals/
URI Parameters
- proposalNumber
string(optional)The unique proposal number identifying a proposal. This is a system generated, sequential number. Maximum length is 12.
- proposalTypeCode
string(optional)The type of the proposal. Maximum length is 3.
- continuedFrom
string(optional)A unique institutionally assigned proposal number of a previously submitted proposal. This is applicable when submitting a revised (changed/corrected) application. Maximum length is 8.
- sponsorCode
string(optional)The identification number of the organization or agency that is providing support for the sponsored project. Maximum length is 6.
- activityTypeCode
string(optional)The type of activity proposed, e.g. organized research, instruction, etc. Maximum length is 3.
- ownedByUnitNumber
string(optional)Unit Number. Maximum length is 8.
- requestedStartDateInitial
string(optional)The date the project period will begin. Maximum length is 10.
- requestedEndDateInitial
string(optional)The date the project period will terminate. Maximum length is 10.
- title
string(optional)The proposed title of the project. Maximum length is 200.
- currentAwardNumber
string(optional)A unique institutionally assigned number of a previously funded application. Maximum length is 12.
- deadlineDate
string(optional)The date in which the proposal is due to the sponsoring agency. Additional deadlines may be set by the office authorized to submit proposals on behalf of the institution (e.g. sponsored programs, etc.). Maximum length is 21.
- deadlineTime
string(optional)The time in which the proposal is due to the sponsoring agency. Additional deadlines may be set by the office authorized to submit proposals on behalf of the institution (e.g. sponsored programs, etc.). Maximum length is 15.
- noticeOfOpportunityCode
string(optional)Indicates if the proposal was in response to a solicitation, the type of solicitation or if it is unsolicited. Maximum length is 3.
- deadlineType
string(optional)Indicates the type of proposal deadline. Maximum length is 3.
- anticipatedAwardTypeCode
string(optional)Anticipated Award Type. Maximum length is 3.
- cfdaNumber
string(optional)A unique identifier for the sponsor and the funding opportunity announcement. AKA “Catalogue of Federal Domestic Assistance Number.” The format for this CFDA Number is XX.XXX. Maximum length is 7.
- programAnnouncementNumber
string(optional)A unique identifier associated with each sponsor’s funding opportunity announcement. AKA “Funding Opportunity Announcement number” or “FOA number”. Maximum length is 50.
- primeSponsorCode
string(optional)The sponsor that provides the original source of project funding. Maximum length is 6.
- sponsorProposalNumber
string(optional)The unique identifier assigned by the sponsor when the proposal was submitted. Maximum length is 70.
- nsfSequenceNumber
string(optional)A number used to indicate the type of research activity as defined by the National Science Foundation. NSF codes are not specific for NSF proposals and/or awards. Maximum length is 12.
- subcontracts
string(optional)The proposal will include a sub award with another institution. Maximum length is 1.
- agencyDivisionCode
string(optional)A code that is unique to each NSF division. Currently specific to the NSF only. Maximum length is 50.
- agencyProgramCode
string(optional)A code that is unique to each NSF program. Currently specific to the NSF only. Maximum length is 50.
- programAnnouncementTitle
string(optional)The title of a publicly available document, announcing a federal agency’s intentions to award discretionary grants or cooperative agreements, usually as a result of competition for funds. AKA Funding opportunity announcements, notices of funding availability, or solicitations. Maximum length is 255.
- mailBy
string(optional)This field determines whether the Sponsored Programs Office or the department will be mailing the proposal to the agency/sponsor. Maximum length is 3.
- mailType
string(optional)The method by which the proposal will be delivered to the agency/sponsor. Maximum length is 1.
- mailAccountNumber
string(optional)The internal school account number that should be charged the mailing costs. Maximum length is 7.
- mailDescription
string(optional)Any information that will assist in the delivery of the proposal. Maximum length is 80.
- mailingAddressId
string(optional)The name and address to whom the proposal will be mailed. Maximum length is 6.
- numberOfCopies
string(optional)The number of paper copies of the proposal that should be mailed to the agency/sponsor. Maximum length is 2.
- proposalStateTypeCode
string(optional)The Proposal State for this Proposal Development Document. Maximum length is 3.
- creationStatusCode
string(optional)Creation Status Code.
- submitFlag
string(optional)Submit Flag.
- hierarchyStatus
string(optional)The status of the proposal in a hierarchy. Maximum length is 3.
- hierarchyOriginatingChildProposalNumber
string(optional)Hierarchy Originating Child Proposal Number.
- hierarchyParentProposalNumber
string(optional)Hierarchy Parent Proposal Number.
- hierarchyLastSyncHashCode
string(optional)Hierarchy Last Sync Hash Code.
- hierarchyBudgetType
string(optional)The type of the budget for this proposal in a hierarchy. Maximum length is 3.
- proposalNumberForGG
string(optional)Grants.gov Opportunity. Maximum length is 12.
- opportunityIdForGG
string(optional)Grants.gov Opportunity. Maximum length is 50.
- agencyRoutingIdentifier
string(optional)The Agency Routing Identifier. Maximum length is 50.
- prevGrantsGovTrackingID
string(optional)Prev Grants.Gov Tracking ID. Maximum length is 50.
- createTimestamp
string(optional)Proposal Create Date. Maximum length is 21.
- createUser
string(optional)Create User.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"continuedFrom": "(val)",
"sponsorCode": "(val)",
"activityTypeCode": "(val)",
"ownedByUnitNumber": "(val)",
"requestedStartDateInitial": "(val)",
"requestedEndDateInitial": "(val)",
"title": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"noticeOfOpportunityCode": "(val)",
"deadlineType": "(val)",
"anticipatedAwardTypeCode": "(val)",
"cfdaNumber": "(val)",
"programAnnouncementNumber": "(val)",
"primeSponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"nsfSequenceNumber": "(val)",
"subcontracts": "(val)",
"agencyDivisionCode": "(val)",
"agencyProgramCode": "(val)",
"programAnnouncementTitle": "(val)",
"mailBy": "(val)",
"mailType": "(val)",
"mailAccountNumber": "(val)",
"mailDescription": "(val)",
"mailingAddressId": "(val)",
"numberOfCopies": "(val)",
"proposalStateTypeCode": "(val)",
"creationStatusCode": "(val)",
"submitFlag": "(val)",
"hierarchyStatus": "(val)",
"hierarchyOriginatingChildProposalNumber": "(val)",
"hierarchyParentProposalNumber": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"hierarchyBudgetType": "(val)",
"proposalNumberForGG": "(val)",
"opportunityIdForGG": "(val)",
"agencyRoutingIdentifier": "(val)",
"prevGrantsGovTrackingID": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"proposalTypeCode": "(val)",
"continuedFrom": "(val)",
"sponsorCode": "(val)",
"activityTypeCode": "(val)",
"ownedByUnitNumber": "(val)",
"requestedStartDateInitial": "(val)",
"requestedEndDateInitial": "(val)",
"title": "(val)",
"currentAwardNumber": "(val)",
"deadlineDate": "(val)",
"deadlineTime": "(val)",
"noticeOfOpportunityCode": "(val)",
"deadlineType": "(val)",
"anticipatedAwardTypeCode": "(val)",
"cfdaNumber": "(val)",
"programAnnouncementNumber": "(val)",
"primeSponsorCode": "(val)",
"sponsorProposalNumber": "(val)",
"nsfSequenceNumber": "(val)",
"subcontracts": "(val)",
"agencyDivisionCode": "(val)",
"agencyProgramCode": "(val)",
"programAnnouncementTitle": "(val)",
"mailBy": "(val)",
"mailType": "(val)",
"mailAccountNumber": "(val)",
"mailDescription": "(val)",
"mailingAddressId": "(val)",
"numberOfCopies": "(val)",
"proposalStateTypeCode": "(val)",
"creationStatusCode": "(val)",
"submitFlag": "(val)",
"hierarchyStatus": "(val)",
"hierarchyOriginatingChildProposalNumber": "(val)",
"hierarchyParentProposalNumber": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"hierarchyBudgetType": "(val)",
"proposalNumberForGG": "(val)",
"opportunityIdForGG": "(val)",
"agencyRoutingIdentifier": "(val)",
"prevGrantsGovTrackingID": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Development ProposalsGET/propdev/api/v1/development-proposals/
Example URI
GET /propdev/api/v1/development-proposals/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"proposalNumber",
"proposalTypeCode",
"continuedFrom",
"sponsorCode",
"activityTypeCode",
"ownedByUnitNumber",
"requestedStartDateInitial",
"requestedEndDateInitial",
"title",
"currentAwardNumber",
"deadlineDate",
"deadlineTime",
"noticeOfOpportunityCode",
"deadlineType",
"anticipatedAwardTypeCode",
"cfdaNumber",
"programAnnouncementNumber",
"primeSponsorCode",
"sponsorProposalNumber",
"nsfSequenceNumber",
"subcontracts",
"agencyDivisionCode",
"agencyProgramCode",
"programAnnouncementTitle",
"mailBy",
"mailType",
"mailAccountNumber",
"mailDescription",
"mailingAddressId",
"numberOfCopies",
"proposalStateTypeCode",
"creationStatusCode",
"submitFlag",
"hierarchyStatus",
"hierarchyOriginatingChildProposalNumber",
"hierarchyParentProposalNumber",
"hierarchyLastSyncHashCode",
"hierarchyBudgetType",
"proposalNumberForGG",
"opportunityIdForGG",
"agencyRoutingIdentifier",
"prevGrantsGovTrackingID",
"createTimestamp",
"createUser"
],
"primaryKey": "proposalNumber"
}Get Blueprint API specification for Development ProposalsGET/propdev/api/v1/development-proposals/
Example URI
GET /propdev/api/v1/development-proposals/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Development Proposals.md"
transfer-encoding: chunkedModular Budget Idcs ¶
Get Modular Budget Idcs by KeyGET/propdev/api/v1/modular-budget-idcs/(key)
Example URI
GET /propdev/api/v1/modular-budget-idcs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
}Get All Modular Budget IdcsGET/propdev/api/v1/modular-budget-idcs/
Example URI
GET /propdev/api/v1/modular-budget-idcs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Modular Budget Idcs with FilteringGET/propdev/api/v1/modular-budget-idcs/
Example URI
GET /propdev/api/v1/modular-budget-idcs/
URI Parameters
- budgetPeriodId
string(optional)Budget Period Id.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- rateNumber
string(optional)Rate Number. Maximum length is 3.
- budgetId
string(optional)Budget Id.
- description
string(optional)Description. Maximum length is 64.
- idcRate
string(optional)IDC Rate. Maximum length is 7.
- idcBase
string(optional)IDC Base. Maximum length is 15.
- idcBaseUnrounded
string(optional)Idc Base Unrounded.
- fundsRequested
string(optional)Funds Requested. Maximum length is 15.
- startDate
string(optional)Start Date.
- endDate
string(optional)End Date.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Modular Budget IdcsGET/propdev/api/v1/modular-budget-idcs/
Example URI
GET /propdev/api/v1/modular-budget-idcs/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetPeriodId",
"budgetPeriod",
"rateNumber",
"budgetId",
"description",
"idcRate",
"idcBase",
"idcBaseUnrounded",
"fundsRequested",
"startDate",
"endDate",
"hierarchyProposalNumber"
],
"primaryKey": "budgetModular:budgetPeriodId:rateNumber"
}Get Blueprint API specification for Modular Budget IdcsGET/propdev/api/v1/modular-budget-idcs/
Example URI
GET /propdev/api/v1/modular-budget-idcs/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Modular Budget Idcs.md"
transfer-encoding: chunkedUpdate Modular Budget IdcsPUT/propdev/api/v1/modular-budget-idcs/(key)
Example URI
PUT /propdev/api/v1/modular-budget-idcs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Modular Budget IdcsPUT/propdev/api/v1/modular-budget-idcs/
Example URI
PUT /propdev/api/v1/modular-budget-idcs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Modular Budget IdcsPATCH/propdev/api/v1/modular-budget-idcs/(key)
Example URI
PATCH /propdev/api/v1/modular-budget-idcs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
}Insert Modular Budget IdcsPOST/propdev/api/v1/modular-budget-idcs/
Example URI
POST /propdev/api/v1/modular-budget-idcs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Modular Budget IdcsPOST/propdev/api/v1/modular-budget-idcs/
Example URI
POST /propdev/api/v1/modular-budget-idcs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"rateNumber": "(val)",
"budgetId": "(val)",
"description": "(val)",
"idcRate": "(val)",
"idcBase": "(val)",
"idcBaseUnrounded": "(val)",
"fundsRequested": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"hierarchyProposalNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Modular Budget Idcs by KeyDELETE/propdev/api/v1/modular-budget-idcs/(key)
Example URI
DELETE /propdev/api/v1/modular-budget-idcs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Modular Budget IdcsDELETE/propdev/api/v1/modular-budget-idcs/
Example URI
DELETE /propdev/api/v1/modular-budget-idcs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Modular Budget Idcs with MatchingDELETE/propdev/api/v1/modular-budget-idcs/
Example URI
DELETE /propdev/api/v1/modular-budget-idcs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- budgetPeriodId
string(optional)Budget Period Id.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- rateNumber
string(optional)Rate Number. Maximum length is 3.
- budgetId
string(optional)Budget Id.
- description
string(optional)Description. Maximum length is 64.
- idcRate
string(optional)IDC Rate. Maximum length is 7.
- idcBase
string(optional)IDC Base. Maximum length is 15.
- idcBaseUnrounded
string(optional)Idc Base Unrounded.
- fundsRequested
string(optional)Funds Requested. Maximum length is 15.
- startDate
string(optional)Start Date.
- endDate
string(optional)End Date.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Modular Budgets ¶
Get Modular Budgets by KeyGET/propdev/api/v1/modular-budgets/(key)
Example URI
GET /propdev/api/v1/modular-budgets/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetPeriodId": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"directCostLessConsortiumFna": "(val)",
"consortiumFna": "(val)",
"totalDirectCost": "(val)",
"_primaryKey": "(val)"
}Get All Modular BudgetsGET/propdev/api/v1/modular-budgets/
Example URI
GET /propdev/api/v1/modular-budgets/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPeriodId": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"directCostLessConsortiumFna": "(val)",
"consortiumFna": "(val)",
"totalDirectCost": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodId": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"directCostLessConsortiumFna": "(val)",
"consortiumFna": "(val)",
"totalDirectCost": "(val)",
"_primaryKey": "(val)"
}
]Get All Modular Budgets with FilteringGET/propdev/api/v1/modular-budgets/
Example URI
GET /propdev/api/v1/modular-budgets/
URI Parameters
- budgetPeriodId
string(optional)Budget Period Id.
- budgetId
string(optional)Budget Id.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- directCostLessConsortiumFna
string(optional)Direct Cost Less Consortium FNA. Maximum length is 15.
- consortiumFna
string(optional)Consortium FNA. Maximum length is 15.
- totalDirectCost
string(optional)Total Direct Cost. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPeriodId": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"directCostLessConsortiumFna": "(val)",
"consortiumFna": "(val)",
"totalDirectCost": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodId": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"directCostLessConsortiumFna": "(val)",
"consortiumFna": "(val)",
"totalDirectCost": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Modular BudgetsGET/propdev/api/v1/modular-budgets/
Example URI
GET /propdev/api/v1/modular-budgets/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetPeriodId",
"budgetId",
"budgetPeriod",
"directCostLessConsortiumFna",
"consortiumFna",
"totalDirectCost"
],
"primaryKey": "budgetPeriodObj"
}Get Blueprint API specification for Modular BudgetsGET/propdev/api/v1/modular-budgets/
Example URI
GET /propdev/api/v1/modular-budgets/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Modular Budgets.md"
transfer-encoding: chunkedNarrative Attachments ¶
Get Narrative Attachments by KeyGET/propdev/api/v1/narrative-attachments/(key)
Example URI
GET /propdev/api/v1/narrative-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
}Get All Narrative AttachmentsGET/propdev/api/v1/narrative-attachments/
Example URI
GET /propdev/api/v1/narrative-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
},
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
}
]Get All Narrative Attachments with FilteringGET/propdev/api/v1/narrative-attachments/
Example URI
GET /propdev/api/v1/narrative-attachments/
URI Parameters
- uploadTimestamp
string(optional)Upload Timestamp.
- name
string(optional)File Name. Maximum length is 150.
- type
string(optional)Type.
- fileDataId
string(optional)File Data Id.
- uploadUser
string(optional)Upload User.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
},
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Narrative AttachmentsGET/propdev/api/v1/narrative-attachments/
Example URI
GET /propdev/api/v1/narrative-attachments/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"uploadTimestamp",
"name",
"type",
"fileDataId",
"uploadUser"
],
"primaryKey": "narrative"
}Get Blueprint API specification for Narrative AttachmentsGET/propdev/api/v1/narrative-attachments/
Example URI
GET /propdev/api/v1/narrative-attachments/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Narrative Attachments.md"
transfer-encoding: chunkedUpdate Narrative AttachmentsPUT/propdev/api/v1/narrative-attachments/(key)
Example URI
PUT /propdev/api/v1/narrative-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Narrative AttachmentsPUT/propdev/api/v1/narrative-attachments/
Example URI
PUT /propdev/api/v1/narrative-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
},
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Narrative AttachmentsPATCH/propdev/api/v1/narrative-attachments/(key)
Example URI
PATCH /propdev/api/v1/narrative-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
}Insert Narrative AttachmentsPOST/propdev/api/v1/narrative-attachments/
Example URI
POST /propdev/api/v1/narrative-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Narrative AttachmentsPOST/propdev/api/v1/narrative-attachments/
Example URI
POST /propdev/api/v1/narrative-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
},
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
},
{
"uploadTimestamp": "(val)",
"name": "(val)",
"type": "(val)",
"fileDataId": "(val)",
"uploadUser": "(val)",
"_primaryKey": "(val)"
}
]Delete Narrative Attachments by KeyDELETE/propdev/api/v1/narrative-attachments/(key)
Example URI
DELETE /propdev/api/v1/narrative-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Narrative AttachmentsDELETE/propdev/api/v1/narrative-attachments/
Example URI
DELETE /propdev/api/v1/narrative-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Narrative Attachments with MatchingDELETE/propdev/api/v1/narrative-attachments/
Example URI
DELETE /propdev/api/v1/narrative-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- uploadTimestamp
string(optional)Upload Timestamp.
- name
string(optional)File Name. Maximum length is 150.
- type
string(optional)Type.
- fileDataId
string(optional)File Data Id.
- uploadUser
string(optional)Upload User.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Narrative Statuses ¶
Get Narrative Statuses by KeyGET/propdev/api/v1/narrative-statuses/(key)
Example URI
GET /propdev/api/v1/narrative-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Narrative StatusesGET/propdev/api/v1/narrative-statuses/
Example URI
GET /propdev/api/v1/narrative-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Narrative Statuses with FilteringGET/propdev/api/v1/narrative-statuses/
Example URI
GET /propdev/api/v1/narrative-statuses/
URI Parameters
- code
string(optional)Narrative Status Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 20.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Narrative StatusesGET/propdev/api/v1/narrative-statuses/
Example URI
GET /propdev/api/v1/narrative-statuses/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Narrative StatusesGET/propdev/api/v1/narrative-statuses/
Example URI
GET /propdev/api/v1/narrative-statuses/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Narrative Statuses.md"
transfer-encoding: chunkedUpdate Narrative StatusesPUT/propdev/api/v1/narrative-statuses/(key)
Example URI
PUT /propdev/api/v1/narrative-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Narrative StatusesPUT/propdev/api/v1/narrative-statuses/
Example URI
PUT /propdev/api/v1/narrative-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Narrative StatusesPATCH/propdev/api/v1/narrative-statuses/(key)
Example URI
PATCH /propdev/api/v1/narrative-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Narrative StatusesPOST/propdev/api/v1/narrative-statuses/
Example URI
POST /propdev/api/v1/narrative-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Narrative StatusesPOST/propdev/api/v1/narrative-statuses/
Example URI
POST /propdev/api/v1/narrative-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Narrative Statuses by KeyDELETE/propdev/api/v1/narrative-statuses/(key)
Example URI
DELETE /propdev/api/v1/narrative-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Narrative StatusesDELETE/propdev/api/v1/narrative-statuses/
Example URI
DELETE /propdev/api/v1/narrative-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Narrative Statuses with MatchingDELETE/propdev/api/v1/narrative-statuses/
Example URI
DELETE /propdev/api/v1/narrative-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Narrative Status Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 20.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Narrative Types ¶
Get Narrative Types by KeyGET/propdev/api/v1/narrative-types/(key)
Example URI
GET /propdev/api/v1/narrative-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
}Get All Narrative TypesGET/propdev/api/v1/narrative-types/
Example URI
GET /propdev/api/v1/narrative-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
}
]Get All Narrative Types with FilteringGET/propdev/api/v1/narrative-types/
Example URI
GET /propdev/api/v1/narrative-types/
URI Parameters
- code
string(optional)Narrative Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- systemGenerated
string(optional)System Generated. Maximum length is 1.
- allowMultiple
string(optional)Allow Multiple. Maximum length is 1.
- narrativeTypeGroup
string(optional)Narrative Type Group. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Narrative TypesGET/propdev/api/v1/narrative-types/
Example URI
GET /propdev/api/v1/narrative-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description",
"systemGenerated",
"allowMultiple",
"narrativeTypeGroup"
],
"primaryKey": "code"
}Get Blueprint API specification for Narrative TypesGET/propdev/api/v1/narrative-types/
Example URI
GET /propdev/api/v1/narrative-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Narrative Types.md"
transfer-encoding: chunkedUpdate Narrative TypesPUT/propdev/api/v1/narrative-types/(key)
Example URI
PUT /propdev/api/v1/narrative-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Narrative TypesPUT/propdev/api/v1/narrative-types/
Example URI
PUT /propdev/api/v1/narrative-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Narrative TypesPATCH/propdev/api/v1/narrative-types/(key)
Example URI
PATCH /propdev/api/v1/narrative-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
}Insert Narrative TypesPOST/propdev/api/v1/narrative-types/
Example URI
POST /propdev/api/v1/narrative-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Narrative TypesPOST/propdev/api/v1/narrative-types/
Example URI
POST /propdev/api/v1/narrative-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"systemGenerated": "(val)",
"allowMultiple": "(val)",
"narrativeTypeGroup": "(val)",
"_primaryKey": "(val)"
}
]Delete Narrative Types by KeyDELETE/propdev/api/v1/narrative-types/(key)
Example URI
DELETE /propdev/api/v1/narrative-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Narrative TypesDELETE/propdev/api/v1/narrative-types/
Example URI
DELETE /propdev/api/v1/narrative-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Narrative Types with MatchingDELETE/propdev/api/v1/narrative-types/
Example URI
DELETE /propdev/api/v1/narrative-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Narrative Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- systemGenerated
string(optional)System Generated. Maximum length is 1.
- allowMultiple
string(optional)Allow Multiple. Maximum length is 1.
- narrativeTypeGroup
string(optional)Narrative Type Group. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Narrative User Rights ¶
Get Narrative User Rights by KeyGET/propdev/api/v1/narrative-user-rights/(key)
Example URI
GET /propdev/api/v1/narrative-user-rights/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
}Get All Narrative User RightsGET/propdev/api/v1/narrative-user-rights/
Example URI
GET /propdev/api/v1/narrative-user-rights/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
},
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
}
]Get All Narrative User Rights with FilteringGET/propdev/api/v1/narrative-user-rights/
Example URI
GET /propdev/api/v1/narrative-user-rights/
URI Parameters
- moduleNumber
string(optional)Module Number. Maximum length is 4.
- proposalNumber
string(optional)Proposal Number. Maximum length is 12.
- userId
string(optional)User Id. Maximum length is 40.
- accessType
string(optional)Access Type. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
},
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Narrative User RightsGET/propdev/api/v1/narrative-user-rights/
Example URI
GET /propdev/api/v1/narrative-user-rights/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"moduleNumber",
"proposalNumber",
"userId",
"accessType"
],
"primaryKey": "moduleNumber:proposalNumber:userId"
}Get Blueprint API specification for Narrative User RightsGET/propdev/api/v1/narrative-user-rights/
Example URI
GET /propdev/api/v1/narrative-user-rights/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Narrative User Rights.md"
transfer-encoding: chunkedUpdate Narrative User RightsPUT/propdev/api/v1/narrative-user-rights/(key)
Example URI
PUT /propdev/api/v1/narrative-user-rights/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Narrative User RightsPUT/propdev/api/v1/narrative-user-rights/
Example URI
PUT /propdev/api/v1/narrative-user-rights/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
},
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Narrative User RightsPATCH/propdev/api/v1/narrative-user-rights/(key)
Example URI
PATCH /propdev/api/v1/narrative-user-rights/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
}Insert Narrative User RightsPOST/propdev/api/v1/narrative-user-rights/
Example URI
POST /propdev/api/v1/narrative-user-rights/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Narrative User RightsPOST/propdev/api/v1/narrative-user-rights/
Example URI
POST /propdev/api/v1/narrative-user-rights/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
},
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
},
{
"moduleNumber": "(val)",
"proposalNumber": "(val)",
"userId": "(val)",
"accessType": "(val)",
"_primaryKey": "(val)"
}
]Delete Narrative User Rights by KeyDELETE/propdev/api/v1/narrative-user-rights/(key)
Example URI
DELETE /propdev/api/v1/narrative-user-rights/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Narrative User RightsDELETE/propdev/api/v1/narrative-user-rights/
Example URI
DELETE /propdev/api/v1/narrative-user-rights/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Narrative User Rights with MatchingDELETE/propdev/api/v1/narrative-user-rights/
Example URI
DELETE /propdev/api/v1/narrative-user-rights/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- moduleNumber
string(optional)Module Number. Maximum length is 4.
- proposalNumber
string(optional)Proposal Number. Maximum length is 12.
- userId
string(optional)User Id. Maximum length is 40.
- accessType
string(optional)Access Type. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Narratives ¶
Get Narratives by KeyGET/propdev/api/v1/narratives/(key)
Example URI
GET /propdev/api/v1/narratives/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Get All NarrativesGET/propdev/api/v1/narratives/
Example URI
GET /propdev/api/v1/narratives/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get All Narratives with FilteringGET/propdev/api/v1/narratives/
Example URI
GET /propdev/api/v1/narratives/
URI Parameters
- moduleNumber
string(optional)Module Number. Maximum length is 4.
- comments
string(optional)Proposal attachment comments. Maximum length is 3950.
- contactName
string(optional)Contact Name. Maximum length is 30.
- emailAddress
string(optional)Email Address. Maximum length is 60.
- moduleSequenceNumber
string(optional)Module Sequence Number. Maximum length is 4.
- moduleStatusCode
string(optional)The Types that the Proposal Attachment Status be. Maximum length is 3.
- moduleTitle
string(optional)This field is a free-form text field in which the user is able to name the attachment they are uploading beyond merely the type. Ex. ‘Mass Spectrometer Quotation’ instead of merely having “equipment” as an attachment type. Maximum length is 150.
- narrativeTypeCode
string(optional)Types of the Proposal Attachments. Maximum length is 3.
- phoneNumber
string(optional)Phone Number. Maximum length is 20.
- name
string(optional)This is the name of the file path and name that the user is uploading; can be typed in or the user can use the “browse” feature to find the file on their computer or attached mass storage device. Maximum length is 150.
- type
string(optional)Type.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for NarrativesGET/propdev/api/v1/narratives/
Example URI
GET /propdev/api/v1/narratives/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"moduleNumber",
"comments",
"contactName",
"emailAddress",
"moduleSequenceNumber",
"moduleStatusCode",
"moduleTitle",
"narrativeTypeCode",
"phoneNumber",
"name",
"type",
"hierarchyProposalNumber",
"hiddenInHierarchy"
],
"primaryKey": "developmentProposal:moduleNumber"
}Get Blueprint API specification for NarrativesGET/propdev/api/v1/narratives/
Example URI
GET /propdev/api/v1/narratives/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Narratives.md"
transfer-encoding: chunkedUpdate NarrativesPUT/propdev/api/v1/narratives/(key)
Example URI
PUT /propdev/api/v1/narratives/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple NarrativesPUT/propdev/api/v1/narratives/
Example URI
PUT /propdev/api/v1/narratives/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes NarrativesPATCH/propdev/api/v1/narratives/(key)
Example URI
PATCH /propdev/api/v1/narratives/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert NarrativesPOST/propdev/api/v1/narratives/
Example URI
POST /propdev/api/v1/narratives/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert Multiple NarrativesPOST/propdev/api/v1/narratives/
Example URI
POST /propdev/api/v1/narratives/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"moduleNumber": "(val)",
"comments": "(val)",
"contactName": "(val)",
"emailAddress": "(val)",
"moduleSequenceNumber": "(val)",
"moduleStatusCode": "(val)",
"moduleTitle": "(val)",
"narrativeTypeCode": "(val)",
"phoneNumber": "(val)",
"name": "(val)",
"type": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Delete Narratives by KeyDELETE/propdev/api/v1/narratives/(key)
Example URI
DELETE /propdev/api/v1/narratives/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All NarrativesDELETE/propdev/api/v1/narratives/
Example URI
DELETE /propdev/api/v1/narratives/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Narratives with MatchingDELETE/propdev/api/v1/narratives/
Example URI
DELETE /propdev/api/v1/narratives/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- moduleNumber
string(optional)Module Number. Maximum length is 4.
- comments
string(optional)Proposal attachment comments. Maximum length is 3950.
- contactName
string(optional)Contact Name. Maximum length is 30.
- emailAddress
string(optional)Email Address. Maximum length is 60.
- moduleSequenceNumber
string(optional)Module Sequence Number. Maximum length is 4.
- moduleStatusCode
string(optional)The Types that the Proposal Attachment Status be. Maximum length is 3.
- moduleTitle
string(optional)This field is a free-form text field in which the user is able to name the attachment they are uploading beyond merely the type. Ex. ‘Mass Spectrometer Quotation’ instead of merely having “equipment” as an attachment type. Maximum length is 150.
- narrativeTypeCode
string(optional)Types of the Proposal Attachments. Maximum length is 3.
- phoneNumber
string(optional)Phone Number. Maximum length is 20.
- name
string(optional)This is the name of the file path and name that the user is uploading; can be typed in or the user can use the “browse” feature to find the file on their computer or attached mass storage device. Maximum length is 150.
- type
string(optional)Type.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Prop Science Keywords ¶
Get Prop Science Keywords by KeyGET/propdev/api/v1/prop-science-keywords/(key)
Example URI
GET /propdev/api/v1/prop-science-keywords/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Get All Prop Science KeywordsGET/propdev/api/v1/prop-science-keywords/
Example URI
GET /propdev/api/v1/prop-science-keywords/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get All Prop Science Keywords with FilteringGET/propdev/api/v1/prop-science-keywords/
Example URI
GET /propdev/api/v1/prop-science-keywords/
URI Parameters
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Prop Science KeywordsGET/propdev/api/v1/prop-science-keywords/
Example URI
GET /propdev/api/v1/prop-science-keywords/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"hierarchyProposalNumber",
"hiddenInHierarchy"
],
"primaryKey": "developmentProposal:scienceKeyword"
}Get Blueprint API specification for Prop Science KeywordsGET/propdev/api/v1/prop-science-keywords/
Example URI
GET /propdev/api/v1/prop-science-keywords/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Prop Science Keywords.md"
transfer-encoding: chunkedUpdate Prop Science KeywordsPUT/propdev/api/v1/prop-science-keywords/(key)
Example URI
PUT /propdev/api/v1/prop-science-keywords/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Prop Science KeywordsPUT/propdev/api/v1/prop-science-keywords/
Example URI
PUT /propdev/api/v1/prop-science-keywords/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Prop Science KeywordsPATCH/propdev/api/v1/prop-science-keywords/(key)
Example URI
PATCH /propdev/api/v1/prop-science-keywords/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert Prop Science KeywordsPOST/propdev/api/v1/prop-science-keywords/
Example URI
POST /propdev/api/v1/prop-science-keywords/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Prop Science KeywordsPOST/propdev/api/v1/prop-science-keywords/
Example URI
POST /propdev/api/v1/prop-science-keywords/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Delete Prop Science Keywords by KeyDELETE/propdev/api/v1/prop-science-keywords/(key)
Example URI
DELETE /propdev/api/v1/prop-science-keywords/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Prop Science KeywordsDELETE/propdev/api/v1/prop-science-keywords/
Example URI
DELETE /propdev/api/v1/prop-science-keywords/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Prop Science Keywords with MatchingDELETE/propdev/api/v1/prop-science-keywords/
Example URI
DELETE /propdev/api/v1/prop-science-keywords/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Abstracts ¶
Get Proposal Abstracts by KeyGET/propdev/api/v1/proposal-abstracts/(key)
Example URI
GET /propdev/api/v1/proposal-abstracts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
}Get All Proposal AbstractsGET/propdev/api/v1/proposal-abstracts/
Example URI
GET /propdev/api/v1/proposal-abstracts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Abstracts with FilteringGET/propdev/api/v1/proposal-abstracts/
Example URI
GET /propdev/api/v1/proposal-abstracts/
URI Parameters
- proposalNumber
string(optional)Proposal Number. Maximum length is 12.
- abstractTypeCode
string(optional)Abstract Type. Maximum length is 3.
- abstractDetails
string(optional)Abstract Details. Maximum length is 49000.
- timestampDisplay
string(optional)Timestamp Display.
- uploadUserDisplay
string(optional)Upload User Display.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal AbstractsGET/propdev/api/v1/proposal-abstracts/
Example URI
GET /propdev/api/v1/proposal-abstracts/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"proposalNumber",
"abstractTypeCode",
"abstractDetails",
"timestampDisplay",
"uploadUserDisplay"
],
"primaryKey": "abstractTypeCode:proposalNumber"
}Get Blueprint API specification for Proposal AbstractsGET/propdev/api/v1/proposal-abstracts/
Example URI
GET /propdev/api/v1/proposal-abstracts/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Abstracts.md"
transfer-encoding: chunkedUpdate Proposal AbstractsPUT/propdev/api/v1/proposal-abstracts/(key)
Example URI
PUT /propdev/api/v1/proposal-abstracts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal AbstractsPUT/propdev/api/v1/proposal-abstracts/
Example URI
PUT /propdev/api/v1/proposal-abstracts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal AbstractsPATCH/propdev/api/v1/proposal-abstracts/(key)
Example URI
PATCH /propdev/api/v1/proposal-abstracts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
}Insert Proposal AbstractsPOST/propdev/api/v1/proposal-abstracts/
Example URI
POST /propdev/api/v1/proposal-abstracts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal AbstractsPOST/propdev/api/v1/proposal-abstracts/
Example URI
POST /propdev/api/v1/proposal-abstracts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"abstractTypeCode": "(val)",
"abstractDetails": "(val)",
"timestampDisplay": "(val)",
"uploadUserDisplay": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Abstracts by KeyDELETE/propdev/api/v1/proposal-abstracts/(key)
Example URI
DELETE /propdev/api/v1/proposal-abstracts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal AbstractsDELETE/propdev/api/v1/proposal-abstracts/
Example URI
DELETE /propdev/api/v1/proposal-abstracts/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Abstracts with MatchingDELETE/propdev/api/v1/proposal-abstracts/
Example URI
DELETE /propdev/api/v1/proposal-abstracts/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- proposalNumber
string(optional)Proposal Number. Maximum length is 12.
- abstractTypeCode
string(optional)Abstract Type. Maximum length is 3.
- abstractDetails
string(optional)Abstract Details. Maximum length is 49000.
- timestampDisplay
string(optional)Timestamp Display.
- uploadUserDisplay
string(optional)Upload User Display.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Changed Data ¶
Get Proposal Changed Data by KeyGET/propdev/api/v1/proposal-changed-data/(key)
Example URI
GET /propdev/api/v1/proposal-changed-data/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Changed DataGET/propdev/api/v1/proposal-changed-data/
Example URI
GET /propdev/api/v1/proposal-changed-data/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
},
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Changed Data with FilteringGET/propdev/api/v1/proposal-changed-data/
Example URI
GET /propdev/api/v1/proposal-changed-data/
URI Parameters
- changeNumber
string(optional)Change Number. Maximum length is 3.
- columnName
string(optional)Field. Maximum length is 30.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8.
- changedValue
string(optional)Changed Value. Maximum length is 200.
- comments
string(optional)Comments. Maximum length is 300.
- displayValue
string(optional)Display Value. Maximum length is 200.
- oldDisplayValue
string(optional)Old Display Value. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
},
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Changed DataGET/propdev/api/v1/proposal-changed-data/
Example URI
GET /propdev/api/v1/proposal-changed-data/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"changeNumber",
"columnName",
"proposalNumber",
"changedValue",
"comments",
"displayValue",
"oldDisplayValue"
],
"primaryKey": "changeNumber:columnName:proposalNumber"
}Get Blueprint API specification for Proposal Changed DataGET/propdev/api/v1/proposal-changed-data/
Example URI
GET /propdev/api/v1/proposal-changed-data/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Changed Data.md"
transfer-encoding: chunkedUpdate Proposal Changed DataPUT/propdev/api/v1/proposal-changed-data/(key)
Example URI
PUT /propdev/api/v1/proposal-changed-data/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Changed DataPUT/propdev/api/v1/proposal-changed-data/
Example URI
PUT /propdev/api/v1/proposal-changed-data/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
},
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Changed DataPATCH/propdev/api/v1/proposal-changed-data/(key)
Example URI
PATCH /propdev/api/v1/proposal-changed-data/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Changed DataPOST/propdev/api/v1/proposal-changed-data/
Example URI
POST /propdev/api/v1/proposal-changed-data/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Changed DataPOST/propdev/api/v1/proposal-changed-data/
Example URI
POST /propdev/api/v1/proposal-changed-data/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
},
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
},
{
"changeNumber": "(val)",
"columnName": "(val)",
"proposalNumber": "(val)",
"changedValue": "(val)",
"comments": "(val)",
"displayValue": "(val)",
"oldDisplayValue": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Changed Data by KeyDELETE/propdev/api/v1/proposal-changed-data/(key)
Example URI
DELETE /propdev/api/v1/proposal-changed-data/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Changed DataDELETE/propdev/api/v1/proposal-changed-data/
Example URI
DELETE /propdev/api/v1/proposal-changed-data/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Changed Data with MatchingDELETE/propdev/api/v1/proposal-changed-data/
Example URI
DELETE /propdev/api/v1/proposal-changed-data/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- changeNumber
string(optional)Change Number. Maximum length is 3.
- columnName
string(optional)Field. Maximum length is 30.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8.
- changedValue
string(optional)Changed Value. Maximum length is 200.
- comments
string(optional)Comments. Maximum length is 300.
- displayValue
string(optional)Display Value. Maximum length is 200.
- oldDisplayValue
string(optional)Old Display Value. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Columns To Alter ¶
Get Proposal Columns To Alter by KeyGET/propdev/api/v1/proposal-columns-to-alter/(key)
Example URI
GET /propdev/api/v1/proposal-columns-to-alter/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Columns To AlterGET/propdev/api/v1/proposal-columns-to-alter/
Example URI
GET /propdev/api/v1/proposal-columns-to-alter/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
},
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Columns To Alter with FilteringGET/propdev/api/v1/proposal-columns-to-alter/
Example URI
GET /propdev/api/v1/proposal-columns-to-alter/
URI Parameters
- columnName
string(optional)Column Name. Maximum length is 30.
- columnLabel
string(optional)Column Label. Maximum length is 30.
- dataLength
string(optional)Data Length. Maximum length is 4.
- dataType
string(optional)Data Type. Maximum length is 9.
- hasLookup
string(optional)Has Lookup. Maximum length is 1.
- lookupClass
string(optional)Lookup Argument. Maximum length is 100.
- lookupReturn
string(optional)Lookup Return. Maximum length is 50.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
},
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Columns To AlterGET/propdev/api/v1/proposal-columns-to-alter/
Example URI
GET /propdev/api/v1/proposal-columns-to-alter/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"columnName",
"columnLabel",
"dataLength",
"dataType",
"hasLookup",
"lookupClass",
"lookupReturn"
],
"primaryKey": "columnName"
}Get Blueprint API specification for Proposal Columns To AlterGET/propdev/api/v1/proposal-columns-to-alter/
Example URI
GET /propdev/api/v1/proposal-columns-to-alter/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Columns To Alter.md"
transfer-encoding: chunkedUpdate Proposal Columns To AlterPUT/propdev/api/v1/proposal-columns-to-alter/(key)
Example URI
PUT /propdev/api/v1/proposal-columns-to-alter/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Columns To AlterPUT/propdev/api/v1/proposal-columns-to-alter/
Example URI
PUT /propdev/api/v1/proposal-columns-to-alter/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
},
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Columns To AlterPATCH/propdev/api/v1/proposal-columns-to-alter/(key)
Example URI
PATCH /propdev/api/v1/proposal-columns-to-alter/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Columns To AlterPOST/propdev/api/v1/proposal-columns-to-alter/
Example URI
POST /propdev/api/v1/proposal-columns-to-alter/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Columns To AlterPOST/propdev/api/v1/proposal-columns-to-alter/
Example URI
POST /propdev/api/v1/proposal-columns-to-alter/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
},
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
},
{
"columnName": "(val)",
"columnLabel": "(val)",
"dataLength": "(val)",
"dataType": "(val)",
"hasLookup": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Columns To Alter by KeyDELETE/propdev/api/v1/proposal-columns-to-alter/(key)
Example URI
DELETE /propdev/api/v1/proposal-columns-to-alter/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Columns To AlterDELETE/propdev/api/v1/proposal-columns-to-alter/
Example URI
DELETE /propdev/api/v1/proposal-columns-to-alter/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Columns To Alter with MatchingDELETE/propdev/api/v1/proposal-columns-to-alter/
Example URI
DELETE /propdev/api/v1/proposal-columns-to-alter/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- columnName
string(optional)Column Name. Maximum length is 30.
- columnLabel
string(optional)Column Label. Maximum length is 30.
- dataLength
string(optional)Data Length. Maximum length is 4.
- dataType
string(optional)Data Type. Maximum length is 9.
- hasLookup
string(optional)Has Lookup. Maximum length is 1.
- lookupClass
string(optional)Lookup Argument. Maximum length is 100.
- lookupReturn
string(optional)Lookup Return. Maximum length is 50.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Development Budget Overviews ¶
Get Proposal Development Budget Overviews by KeyGET/propdev/api/v1/proposal-development-budget-overviews/(key)
Example URI
GET /propdev/api/v1/proposal-development-budget-overviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Development Budget OverviewsGET/propdev/api/v1/proposal-development-budget-overviews/
Example URI
GET /propdev/api/v1/proposal-development-budget-overviews/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
},
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Development Budget Overviews with FilteringGET/propdev/api/v1/proposal-development-budget-overviews/
Example URI
GET /propdev/api/v1/proposal-development-budget-overviews/
URI Parameters
- budgetId
string(optional)- documentNumber
string(optional)- budgetVersionNumber
string(optional)- costSharingAmount
string(optional)- endDate
string(optional)- modularBudgetFlag
string(optional)- ohRateTypeCode
string(optional)- ohRateClassCode
string(optional)- residualFunds
string(optional)- startDate
string(optional)- totalCost
string(optional)- totalCostLimit
string(optional)- totalDirectCostLimit
string(optional)- totalDirectCost
string(optional)- totalIndirectCost
string(optional)- underrecoveryAmount
string(optional)- comments
string(optional)- onOffCampusFlag
string(optional)- urRateClassCode
string(optional)- submitCostSharingFlag
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
},
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Development Budget OverviewsGET/propdev/api/v1/proposal-development-budget-overviews/
Example URI
GET /propdev/api/v1/proposal-development-budget-overviews/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetId",
"documentNumber",
"budgetVersionNumber",
"costSharingAmount",
"endDate",
"modularBudgetFlag",
"ohRateTypeCode",
"ohRateClassCode",
"residualFunds",
"startDate",
"totalCost",
"totalCostLimit",
"totalDirectCostLimit",
"totalDirectCost",
"totalIndirectCost",
"underrecoveryAmount",
"comments",
"onOffCampusFlag",
"urRateClassCode",
"submitCostSharingFlag"
],
"primaryKey": "budgetId"
}Get Blueprint API specification for Proposal Development Budget OverviewsGET/propdev/api/v1/proposal-development-budget-overviews/
Example URI
GET /propdev/api/v1/proposal-development-budget-overviews/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Development Budget Overviews.md"
transfer-encoding: chunkedUpdate Proposal Development Budget OverviewsPUT/propdev/api/v1/proposal-development-budget-overviews/(key)
Example URI
PUT /propdev/api/v1/proposal-development-budget-overviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Development Budget OverviewsPUT/propdev/api/v1/proposal-development-budget-overviews/
Example URI
PUT /propdev/api/v1/proposal-development-budget-overviews/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
},
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Development Budget OverviewsPATCH/propdev/api/v1/proposal-development-budget-overviews/(key)
Example URI
PATCH /propdev/api/v1/proposal-development-budget-overviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Development Budget OverviewsPOST/propdev/api/v1/proposal-development-budget-overviews/
Example URI
POST /propdev/api/v1/proposal-development-budget-overviews/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Development Budget OverviewsPOST/propdev/api/v1/proposal-development-budget-overviews/
Example URI
POST /propdev/api/v1/proposal-development-budget-overviews/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
},
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
},
{
"budgetId": "(val)",
"documentNumber": "(val)",
"budgetVersionNumber": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"ohRateTypeCode": "(val)",
"ohRateClassCode": "(val)",
"residualFunds": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"comments": "(val)",
"onOffCampusFlag": "(val)",
"urRateClassCode": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Development Budget Overviews by KeyDELETE/propdev/api/v1/proposal-development-budget-overviews/(key)
Example URI
DELETE /propdev/api/v1/proposal-development-budget-overviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Development Budget OverviewsDELETE/propdev/api/v1/proposal-development-budget-overviews/
Example URI
DELETE /propdev/api/v1/proposal-development-budget-overviews/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Development Budget Overviews with MatchingDELETE/propdev/api/v1/proposal-development-budget-overviews/
Example URI
DELETE /propdev/api/v1/proposal-development-budget-overviews/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- budgetId
string(optional)- documentNumber
string(optional)- budgetVersionNumber
string(optional)- costSharingAmount
string(optional)- endDate
string(optional)- modularBudgetFlag
string(optional)- ohRateTypeCode
string(optional)- ohRateClassCode
string(optional)- residualFunds
string(optional)- startDate
string(optional)- totalCost
string(optional)- totalCostLimit
string(optional)- totalDirectCostLimit
string(optional)- totalDirectCost
string(optional)- totalIndirectCost
string(optional)- underrecoveryAmount
string(optional)- comments
string(optional)- onOffCampusFlag
string(optional)- urRateClassCode
string(optional)- submitCostSharingFlag
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Development Budgets ¶
Get Proposal Development Budgets by KeyGET/propdev/api/v1/proposal-development-budgets/(key)
Example URI
GET /propdev/api/v1/proposal-development-budgets/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Development BudgetsGET/propdev/api/v1/proposal-development-budgets/
Example URI
GET /propdev/api/v1/proposal-development-budgets/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
},
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Development Budgets with FilteringGET/propdev/api/v1/proposal-development-budgets/
Example URI
GET /propdev/api/v1/proposal-development-budgets/
URI Parameters
- budgetStatus
string(optional)F&A Rate Type. Maximum length is 1.
- costShareComment
string(optional)Cost Share Comment.
- hierarchyLastSyncHashCode
string(optional)Hierarchy Last Sync Hash Code.
- residualFunds
string(optional)Residual Funds. Maximum length is 15.
- endDate
string(optional)Project End Date. Maximum length is 21.
- modularBudgetFlag
string(optional)Modular Budget Flag. Maximum length is 1.
- documentNumber
string(optional)Document Number.
- totalDirectCostLimit
string(optional)Total Direct Cost Limit. Maximum length is 15.
- budgetAdjustmentDocumentNumber
string(optional)Budget Adjustment Document Number.
- createTimestamp
string(optional)Create Timestamp.
- costSharingAmount
string(optional)Cost Sharing Amount. Maximum length is 15.
- totalDirectCost
string(optional)Total Direct Cost. Maximum length is 15.
- ohRateClassCode
string(optional)F&A Rate Type. Maximum length is 3.
- comments
string(optional)The Comments for this budget. Maximum length is 2000.
- budgetJustification
string(optional)Budget Justification. Maximum length is 4000.
- underrecoveryAmount
string(optional)Underrecovery Amount. Maximum length is 15.
- budgetId
string(optional)Budget Id.
- budgetVersionNumber
string(optional)Budget Version Number for header display. Maximum length is 3.
- urRateClassCode
string(optional)Ur Rate Class Code. Maximum length is 3.
- parentDocumentTypeCode
string(optional)Parent Document Type Code. Maximum length is 31.
- totalIndirectCost
string(optional)Total Indirect Cost. Maximum length is 15.
- totalCostLimit
string(optional)Total Cost Limit. Maximum length is 15.
- name
string(optional)A free-form text field that describes the purpose or function of the document. Maximum length is 40.
- onOffCampusFlag
string(optional)On Off CampusContractContract flag allowing the user to set all expense line items to be either ‘all on’ or ‘all off-campus’; overriding the object code level defaults. Maximum length is 3.
- submitCostSharingFlag
string(optional)Submit Cost Sharing Flag. Maximum length is 1.
- createUser
string(optional)Create User.
- ohRateTypeCode
string(optional)F&A Rate Type. Maximum length is 3.
- startDate
string(optional)Project Start Date. Maximum length is 21.
- totalCost
string(optional)Total Cost. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
},
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Development BudgetsGET/propdev/api/v1/proposal-development-budgets/
Example URI
GET /propdev/api/v1/proposal-development-budgets/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetStatus",
"costShareComment",
"hierarchyLastSyncHashCode",
"residualFunds",
"endDate",
"modularBudgetFlag",
"documentNumber",
"totalDirectCostLimit",
"budgetAdjustmentDocumentNumber",
"createTimestamp",
"costSharingAmount",
"totalDirectCost",
"ohRateClassCode",
"comments",
"budgetJustification",
"underrecoveryAmount",
"budgetId",
"budgetVersionNumber",
"urRateClassCode",
"parentDocumentTypeCode",
"totalIndirectCost",
"totalCostLimit",
"name",
"onOffCampusFlag",
"submitCostSharingFlag",
"createUser",
"ohRateTypeCode",
"startDate",
"totalCost"
],
"primaryKey": "budgetId"
}Get Blueprint API specification for Proposal Development BudgetsGET/propdev/api/v1/proposal-development-budgets/
Example URI
GET /propdev/api/v1/proposal-development-budgets/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Development Budgets.md"
transfer-encoding: chunkedUpdate Proposal Development BudgetsPUT/propdev/api/v1/proposal-development-budgets/(key)
Example URI
PUT /propdev/api/v1/proposal-development-budgets/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Development BudgetsPUT/propdev/api/v1/proposal-development-budgets/
Example URI
PUT /propdev/api/v1/proposal-development-budgets/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
},
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Development BudgetsPATCH/propdev/api/v1/proposal-development-budgets/(key)
Example URI
PATCH /propdev/api/v1/proposal-development-budgets/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Development BudgetsPOST/propdev/api/v1/proposal-development-budgets/
Example URI
POST /propdev/api/v1/proposal-development-budgets/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Development BudgetsPOST/propdev/api/v1/proposal-development-budgets/
Example URI
POST /propdev/api/v1/proposal-development-budgets/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
},
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
},
{
"budgetStatus": "(val)",
"costShareComment": "(val)",
"hierarchyLastSyncHashCode": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"createTimestamp": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"budgetJustification": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"parentDocumentTypeCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"createUser": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Development Budgets by KeyDELETE/propdev/api/v1/proposal-development-budgets/(key)
Example URI
DELETE /propdev/api/v1/proposal-development-budgets/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Development BudgetsDELETE/propdev/api/v1/proposal-development-budgets/
Example URI
DELETE /propdev/api/v1/proposal-development-budgets/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Development Budgets with MatchingDELETE/propdev/api/v1/proposal-development-budgets/
Example URI
DELETE /propdev/api/v1/proposal-development-budgets/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- budgetStatus
string(optional)F&A Rate Type. Maximum length is 1.
- costShareComment
string(optional)Cost Share Comment.
- hierarchyLastSyncHashCode
string(optional)Hierarchy Last Sync Hash Code.
- residualFunds
string(optional)Residual Funds. Maximum length is 15.
- endDate
string(optional)Project End Date. Maximum length is 21.
- modularBudgetFlag
string(optional)Modular Budget Flag. Maximum length is 1.
- documentNumber
string(optional)Document Number.
- totalDirectCostLimit
string(optional)Total Direct Cost Limit. Maximum length is 15.
- budgetAdjustmentDocumentNumber
string(optional)Budget Adjustment Document Number.
- createTimestamp
string(optional)Create Timestamp.
- costSharingAmount
string(optional)Cost Sharing Amount. Maximum length is 15.
- totalDirectCost
string(optional)Total Direct Cost. Maximum length is 15.
- ohRateClassCode
string(optional)F&A Rate Type. Maximum length is 3.
- comments
string(optional)The Comments for this budget. Maximum length is 2000.
- budgetJustification
string(optional)Budget Justification. Maximum length is 4000.
- underrecoveryAmount
string(optional)Underrecovery Amount. Maximum length is 15.
- budgetId
string(optional)Budget Id.
- budgetVersionNumber
string(optional)Budget Version Number for header display. Maximum length is 3.
- urRateClassCode
string(optional)Ur Rate Class Code. Maximum length is 3.
- parentDocumentTypeCode
string(optional)Parent Document Type Code. Maximum length is 31.
- totalIndirectCost
string(optional)Total Indirect Cost. Maximum length is 15.
- totalCostLimit
string(optional)Total Cost Limit. Maximum length is 15.
- name
string(optional)A free-form text field that describes the purpose or function of the document. Maximum length is 40.
- onOffCampusFlag
string(optional)On Off CampusContractContract flag allowing the user to set all expense line items to be either ‘all on’ or ‘all off-campus’; overriding the object code level defaults. Maximum length is 3.
- submitCostSharingFlag
string(optional)Submit Cost Sharing Flag. Maximum length is 1.
- createUser
string(optional)Create User.
- ohRateTypeCode
string(optional)F&A Rate Type. Maximum length is 3.
- startDate
string(optional)Project Start Date. Maximum length is 21.
- totalCost
string(optional)Total Cost. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Development Person Mass Changes ¶
Get Proposal Development Person Mass Changes by KeyGET/propdev/api/v1/proposal-development-person-mass-changes/(key)
Example URI
GET /propdev/api/v1/proposal-development-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Development Person Mass ChangesGET/propdev/api/v1/proposal-development-person-mass-changes/
Example URI
GET /propdev/api/v1/proposal-development-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
},
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Development Person Mass Changes with FilteringGET/propdev/api/v1/proposal-development-person-mass-changes/
Example URI
GET /propdev/api/v1/proposal-development-person-mass-changes/
URI Parameters
- proposalDevelopmentPersonMassChangeId
string(optional)Proposal Development Person Mass Change Id. Maximum length is 12.
- personMassChangeId
string(optional)Person Mass Change Id. Maximum length is 12.
- investigator
string(optional)Investigator. Maximum length is 1.
- mailingInformation
string(optional)Mailing Information. Maximum length is 1.
- keyStudyPerson
string(optional)Key Study Person. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
},
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Development Person Mass ChangesGET/propdev/api/v1/proposal-development-person-mass-changes/
Example URI
GET /propdev/api/v1/proposal-development-person-mass-changes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"proposalDevelopmentPersonMassChangeId",
"personMassChangeId",
"investigator",
"mailingInformation",
"keyStudyPerson"
],
"primaryKey": "proposalDevelopmentPersonMassChangeId"
}Get Blueprint API specification for Proposal Development Person Mass ChangesGET/propdev/api/v1/proposal-development-person-mass-changes/
Example URI
GET /propdev/api/v1/proposal-development-person-mass-changes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Development Person Mass Changes.md"
transfer-encoding: chunkedUpdate Proposal Development Person Mass ChangesPUT/propdev/api/v1/proposal-development-person-mass-changes/(key)
Example URI
PUT /propdev/api/v1/proposal-development-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Development Person Mass ChangesPUT/propdev/api/v1/proposal-development-person-mass-changes/
Example URI
PUT /propdev/api/v1/proposal-development-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
},
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Development Person Mass ChangesPATCH/propdev/api/v1/proposal-development-person-mass-changes/(key)
Example URI
PATCH /propdev/api/v1/proposal-development-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Development Person Mass ChangesPOST/propdev/api/v1/proposal-development-person-mass-changes/
Example URI
POST /propdev/api/v1/proposal-development-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Development Person Mass ChangesPOST/propdev/api/v1/proposal-development-person-mass-changes/
Example URI
POST /propdev/api/v1/proposal-development-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
},
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
},
{
"proposalDevelopmentPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"mailingInformation": "(val)",
"keyStudyPerson": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Development Person Mass Changes by KeyDELETE/propdev/api/v1/proposal-development-person-mass-changes/(key)
Example URI
DELETE /propdev/api/v1/proposal-development-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Development Person Mass ChangesDELETE/propdev/api/v1/proposal-development-person-mass-changes/
Example URI
DELETE /propdev/api/v1/proposal-development-person-mass-changes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Development Person Mass Changes with MatchingDELETE/propdev/api/v1/proposal-development-person-mass-changes/
Example URI
DELETE /propdev/api/v1/proposal-development-person-mass-changes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- proposalDevelopmentPersonMassChangeId
string(optional)Proposal Development Person Mass Change Id. Maximum length is 12.
- personMassChangeId
string(optional)Person Mass Change Id. Maximum length is 12.
- investigator
string(optional)Investigator. Maximum length is 1.
- mailingInformation
string(optional)Mailing Information. Maximum length is 1.
- keyStudyPerson
string(optional)Key Study Person. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Investigator Certifications ¶
Get Proposal Investigator Certifications by KeyGET/propdev/api/v1/proposal-investigator-certifications/(key)
Example URI
GET /propdev/api/v1/proposal-investigator-certifications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Investigator CertificationsGET/propdev/api/v1/proposal-investigator-certifications/
Example URI
GET /propdev/api/v1/proposal-investigator-certifications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
},
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Investigator Certifications with FilteringGET/propdev/api/v1/proposal-investigator-certifications/
Example URI
GET /propdev/api/v1/proposal-investigator-certifications/
URI Parameters
- proposalPersonNumber
string(optional)Proposal Person Number. Maximum length is 40.
- proposalNumber
string(optional)Proposal Number. Maximum length is 40.
- certified
string(optional)Is Certified. Maximum length is 1.
- dateCertified
string(optional)Date Certified. Maximum length is 21.
- dateReceivedByOsp
string(optional)Date Received by OSP. Maximum length is 21.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
},
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Investigator CertificationsGET/propdev/api/v1/proposal-investigator-certifications/
Example URI
GET /propdev/api/v1/proposal-investigator-certifications/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"proposalPersonNumber",
"proposalNumber",
"certified",
"dateCertified",
"dateReceivedByOsp"
],
"primaryKey": "proposalNumber:proposalPersonNumber"
}Get Blueprint API specification for Proposal Investigator CertificationsGET/propdev/api/v1/proposal-investigator-certifications/
Example URI
GET /propdev/api/v1/proposal-investigator-certifications/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Investigator Certifications.md"
transfer-encoding: chunkedUpdate Proposal Investigator CertificationsPUT/propdev/api/v1/proposal-investigator-certifications/(key)
Example URI
PUT /propdev/api/v1/proposal-investigator-certifications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Investigator CertificationsPUT/propdev/api/v1/proposal-investigator-certifications/
Example URI
PUT /propdev/api/v1/proposal-investigator-certifications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
},
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Investigator CertificationsPATCH/propdev/api/v1/proposal-investigator-certifications/(key)
Example URI
PATCH /propdev/api/v1/proposal-investigator-certifications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Investigator CertificationsPOST/propdev/api/v1/proposal-investigator-certifications/
Example URI
POST /propdev/api/v1/proposal-investigator-certifications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Investigator CertificationsPOST/propdev/api/v1/proposal-investigator-certifications/
Example URI
POST /propdev/api/v1/proposal-investigator-certifications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
},
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
},
{
"proposalPersonNumber": "(val)",
"proposalNumber": "(val)",
"certified": "(val)",
"dateCertified": "(val)",
"dateReceivedByOsp": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Investigator Certifications by KeyDELETE/propdev/api/v1/proposal-investigator-certifications/(key)
Example URI
DELETE /propdev/api/v1/proposal-investigator-certifications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Investigator CertificationsDELETE/propdev/api/v1/proposal-investigator-certifications/
Example URI
DELETE /propdev/api/v1/proposal-investigator-certifications/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Investigator Certifications with MatchingDELETE/propdev/api/v1/proposal-investigator-certifications/
Example URI
DELETE /propdev/api/v1/proposal-investigator-certifications/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- proposalPersonNumber
string(optional)Proposal Person Number. Maximum length is 40.
- proposalNumber
string(optional)Proposal Number. Maximum length is 40.
- certified
string(optional)Is Certified. Maximum length is 1.
- dateCertified
string(optional)Date Certified. Maximum length is 21.
- dateReceivedByOsp
string(optional)Date Received by OSP. Maximum length is 21.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Location Types ¶
Get Proposal Location Types by KeyGET/propdev/api/v1/proposal-location-types/(key)
Example URI
GET /propdev/api/v1/proposal-location-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Location TypesGET/propdev/api/v1/proposal-location-types/
Example URI
GET /propdev/api/v1/proposal-location-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
},
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Location Types with FilteringGET/propdev/api/v1/proposal-location-types/
Example URI
GET /propdev/api/v1/proposal-location-types/
URI Parameters
- locationTypeCode
string(optional)Proposal Location Type. Maximum length is 3.
- locationTypeDesc
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
},
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Location TypesGET/propdev/api/v1/proposal-location-types/
Example URI
GET /propdev/api/v1/proposal-location-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"locationTypeCode",
"locationTypeDesc"
],
"primaryKey": "locationTypeCode"
}Get Blueprint API specification for Proposal Location TypesGET/propdev/api/v1/proposal-location-types/
Example URI
GET /propdev/api/v1/proposal-location-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Location Types.md"
transfer-encoding: chunkedUpdate Proposal Location TypesPUT/propdev/api/v1/proposal-location-types/(key)
Example URI
PUT /propdev/api/v1/proposal-location-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Location TypesPUT/propdev/api/v1/proposal-location-types/
Example URI
PUT /propdev/api/v1/proposal-location-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
},
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Location TypesPATCH/propdev/api/v1/proposal-location-types/(key)
Example URI
PATCH /propdev/api/v1/proposal-location-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Location TypesPOST/propdev/api/v1/proposal-location-types/
Example URI
POST /propdev/api/v1/proposal-location-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Location TypesPOST/propdev/api/v1/proposal-location-types/
Example URI
POST /propdev/api/v1/proposal-location-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
},
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
},
{
"locationTypeCode": "(val)",
"locationTypeDesc": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Location Types by KeyDELETE/propdev/api/v1/proposal-location-types/(key)
Example URI
DELETE /propdev/api/v1/proposal-location-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Location TypesDELETE/propdev/api/v1/proposal-location-types/
Example URI
DELETE /propdev/api/v1/proposal-location-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Location Types with MatchingDELETE/propdev/api/v1/proposal-location-types/
Example URI
DELETE /propdev/api/v1/proposal-location-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- locationTypeCode
string(optional)Proposal Location Type. Maximum length is 3.
- locationTypeDesc
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Person Biographies ¶
Get Proposal Person Biographies by KeyGET/propdev/api/v1/proposal-person-biographies/(key)
Example URI
GET /propdev/api/v1/proposal-person-biographies/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Person BiographiesGET/propdev/api/v1/proposal-person-biographies/
Example URI
GET /propdev/api/v1/proposal-person-biographies/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
},
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Person Biographies with FilteringGET/propdev/api/v1/proposal-person-biographies/
Example URI
GET /propdev/api/v1/proposal-person-biographies/
URI Parameters
- proposalPersonNumber
string(optional)This field is auto-populated with the names of the individuals listed in the key personnel section of the proposal. Maximum length is 12.
- personId
string(optional)KcPerson Id. Maximum length is 40.
- biographyNumber
string(optional)Biography Number. Maximum length is 3.
- rolodexId
string(optional)Rolodex Id. Maximum length is 6.
- description
string(optional)Description. Maximum length is 200.
- documentTypeCode
string(optional)This field contains a list of personnel attachment types. Maximum length is 3.
- name
string(optional)This is the name of the file path and name that the user is uploading; can be typed in or the user can use the “browse�? feature to find the file on their computer or attached mass storage device. Maximum length is 150.
- type
string(optional)Type.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
},
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Person BiographiesGET/propdev/api/v1/proposal-person-biographies/
Example URI
GET /propdev/api/v1/proposal-person-biographies/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"proposalPersonNumber",
"personId",
"biographyNumber",
"rolodexId",
"description",
"documentTypeCode",
"name",
"type"
],
"primaryKey": "biographyNumber:developmentProposal:proposalPersonNumber"
}Get Blueprint API specification for Proposal Person BiographiesGET/propdev/api/v1/proposal-person-biographies/
Example URI
GET /propdev/api/v1/proposal-person-biographies/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Person Biographies.md"
transfer-encoding: chunkedUpdate Proposal Person BiographiesPUT/propdev/api/v1/proposal-person-biographies/(key)
Example URI
PUT /propdev/api/v1/proposal-person-biographies/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Person BiographiesPUT/propdev/api/v1/proposal-person-biographies/
Example URI
PUT /propdev/api/v1/proposal-person-biographies/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
},
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Person BiographiesPATCH/propdev/api/v1/proposal-person-biographies/(key)
Example URI
PATCH /propdev/api/v1/proposal-person-biographies/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Person BiographiesPOST/propdev/api/v1/proposal-person-biographies/
Example URI
POST /propdev/api/v1/proposal-person-biographies/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Person BiographiesPOST/propdev/api/v1/proposal-person-biographies/
Example URI
POST /propdev/api/v1/proposal-person-biographies/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
},
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
},
{
"proposalPersonNumber": "(val)",
"personId": "(val)",
"biographyNumber": "(val)",
"rolodexId": "(val)",
"description": "(val)",
"documentTypeCode": "(val)",
"name": "(val)",
"type": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Person Biographies by KeyDELETE/propdev/api/v1/proposal-person-biographies/(key)
Example URI
DELETE /propdev/api/v1/proposal-person-biographies/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Person BiographiesDELETE/propdev/api/v1/proposal-person-biographies/
Example URI
DELETE /propdev/api/v1/proposal-person-biographies/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Person Biographies with MatchingDELETE/propdev/api/v1/proposal-person-biographies/
Example URI
DELETE /propdev/api/v1/proposal-person-biographies/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- proposalPersonNumber
string(optional)This field is auto-populated with the names of the individuals listed in the key personnel section of the proposal. Maximum length is 12.
- personId
string(optional)KcPerson Id. Maximum length is 40.
- biographyNumber
string(optional)Biography Number. Maximum length is 3.
- rolodexId
string(optional)Rolodex Id. Maximum length is 6.
- description
string(optional)Description. Maximum length is 200.
- documentTypeCode
string(optional)This field contains a list of personnel attachment types. Maximum length is 3.
- name
string(optional)This is the name of the file path and name that the user is uploading; can be typed in or the user can use the “browse�? feature to find the file on their computer or attached mass storage device. Maximum length is 150.
- type
string(optional)Type.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Person Credit Splits ¶
Get Proposal Person Credit Splits by KeyGET/propdev/api/v1/proposal-person-credit-splits/(key)
Example URI
GET /propdev/api/v1/proposal-person-credit-splits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Person Credit SplitsGET/propdev/api/v1/proposal-person-credit-splits/
Example URI
GET /propdev/api/v1/proposal-person-credit-splits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
},
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Person Credit Splits with FilteringGET/propdev/api/v1/proposal-person-credit-splits/
Example URI
GET /propdev/api/v1/proposal-person-credit-splits/
URI Parameters
- invCreditTypeCode
string(optional)Investigator Credit Type Code. Maximum length is 3.
- credit
string(optional)Credit. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
},
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Person Credit SplitsGET/propdev/api/v1/proposal-person-credit-splits/
Example URI
GET /propdev/api/v1/proposal-person-credit-splits/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"invCreditTypeCode",
"credit"
],
"primaryKey": "invCreditTypeCode:proposalPerson"
}Get Blueprint API specification for Proposal Person Credit SplitsGET/propdev/api/v1/proposal-person-credit-splits/
Example URI
GET /propdev/api/v1/proposal-person-credit-splits/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Person Credit Splits.md"
transfer-encoding: chunkedUpdate Proposal Person Credit SplitsPUT/propdev/api/v1/proposal-person-credit-splits/(key)
Example URI
PUT /propdev/api/v1/proposal-person-credit-splits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Person Credit SplitsPUT/propdev/api/v1/proposal-person-credit-splits/
Example URI
PUT /propdev/api/v1/proposal-person-credit-splits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
},
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Person Credit SplitsPATCH/propdev/api/v1/proposal-person-credit-splits/(key)
Example URI
PATCH /propdev/api/v1/proposal-person-credit-splits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Person Credit SplitsPOST/propdev/api/v1/proposal-person-credit-splits/
Example URI
POST /propdev/api/v1/proposal-person-credit-splits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Person Credit SplitsPOST/propdev/api/v1/proposal-person-credit-splits/
Example URI
POST /propdev/api/v1/proposal-person-credit-splits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
},
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
},
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Person Credit Splits by KeyDELETE/propdev/api/v1/proposal-person-credit-splits/(key)
Example URI
DELETE /propdev/api/v1/proposal-person-credit-splits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Person Credit SplitsDELETE/propdev/api/v1/proposal-person-credit-splits/
Example URI
DELETE /propdev/api/v1/proposal-person-credit-splits/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Person Credit Splits with MatchingDELETE/propdev/api/v1/proposal-person-credit-splits/
Example URI
DELETE /propdev/api/v1/proposal-person-credit-splits/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- invCreditTypeCode
string(optional)Investigator Credit Type Code. Maximum length is 3.
- credit
string(optional)Credit. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Person Degrees ¶
Get Proposal Person Degrees by KeyGET/propdev/api/v1/proposal-person-degrees/(key)
Example URI
GET /propdev/api/v1/proposal-person-degrees/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Person DegreesGET/propdev/api/v1/proposal-person-degrees/
Example URI
GET /propdev/api/v1/proposal-person-degrees/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
},
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Person Degrees with FilteringGET/propdev/api/v1/proposal-person-degrees/
Example URI
GET /propdev/api/v1/proposal-person-degrees/
URI Parameters
- degreeSequenceNumber
string(optional)Degree Sequence Number. Maximum length is 3.
- graduationYear
string(optional)Graduation Year. Maximum length is 4.
- degreeCode
string(optional)Degree Code. Maximum length is 6.
- degree
string(optional)Degree. Maximum length is 80.
- fieldOfStudy
string(optional)Field of Study. Maximum length is 80.
- specialization
string(optional)Specialization. Maximum length is 80.
- school
string(optional)School. Maximum length is 50.
- schoolIdCode
string(optional)School Id Code. Maximum length is 3.
- schoolId
string(optional)School Id. Maximum length is 20.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
},
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Person DegreesGET/propdev/api/v1/proposal-person-degrees/
Example URI
GET /propdev/api/v1/proposal-person-degrees/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"degreeSequenceNumber",
"graduationYear",
"degreeCode",
"degree",
"fieldOfStudy",
"specialization",
"school",
"schoolIdCode",
"schoolId"
],
"primaryKey": "degreeSequenceNumber:proposalPerson"
}Get Blueprint API specification for Proposal Person DegreesGET/propdev/api/v1/proposal-person-degrees/
Example URI
GET /propdev/api/v1/proposal-person-degrees/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Person Degrees.md"
transfer-encoding: chunkedUpdate Proposal Person DegreesPUT/propdev/api/v1/proposal-person-degrees/(key)
Example URI
PUT /propdev/api/v1/proposal-person-degrees/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Person DegreesPUT/propdev/api/v1/proposal-person-degrees/
Example URI
PUT /propdev/api/v1/proposal-person-degrees/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
},
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Person DegreesPATCH/propdev/api/v1/proposal-person-degrees/(key)
Example URI
PATCH /propdev/api/v1/proposal-person-degrees/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Person DegreesPOST/propdev/api/v1/proposal-person-degrees/
Example URI
POST /propdev/api/v1/proposal-person-degrees/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Person DegreesPOST/propdev/api/v1/proposal-person-degrees/
Example URI
POST /propdev/api/v1/proposal-person-degrees/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
},
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
},
{
"degreeSequenceNumber": "(val)",
"graduationYear": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Person Degrees by KeyDELETE/propdev/api/v1/proposal-person-degrees/(key)
Example URI
DELETE /propdev/api/v1/proposal-person-degrees/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Person DegreesDELETE/propdev/api/v1/proposal-person-degrees/
Example URI
DELETE /propdev/api/v1/proposal-person-degrees/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Person Degrees with MatchingDELETE/propdev/api/v1/proposal-person-degrees/
Example URI
DELETE /propdev/api/v1/proposal-person-degrees/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- degreeSequenceNumber
string(optional)Degree Sequence Number. Maximum length is 3.
- graduationYear
string(optional)Graduation Year. Maximum length is 4.
- degreeCode
string(optional)Degree Code. Maximum length is 6.
- degree
string(optional)Degree. Maximum length is 80.
- fieldOfStudy
string(optional)Field of Study. Maximum length is 80.
- specialization
string(optional)Specialization. Maximum length is 80.
- school
string(optional)School. Maximum length is 50.
- schoolIdCode
string(optional)School Id Code. Maximum length is 3.
- schoolId
string(optional)School Id. Maximum length is 20.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Person Document Types ¶
Get Proposal Person Document Types by KeyGET/propdev/api/v1/proposal-person-document-types/(key)
Example URI
GET /propdev/api/v1/proposal-person-document-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Person Document TypesGET/propdev/api/v1/proposal-person-document-types/
Example URI
GET /propdev/api/v1/proposal-person-document-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Person Document Types with FilteringGET/propdev/api/v1/proposal-person-document-types/
Example URI
GET /propdev/api/v1/proposal-person-document-types/
URI Parameters
- code
string(optional)Person Document Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Person Document TypesGET/propdev/api/v1/proposal-person-document-types/
Example URI
GET /propdev/api/v1/proposal-person-document-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Proposal Person Document TypesGET/propdev/api/v1/proposal-person-document-types/
Example URI
GET /propdev/api/v1/proposal-person-document-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Person Document Types.md"
transfer-encoding: chunkedUpdate Proposal Person Document TypesPUT/propdev/api/v1/proposal-person-document-types/(key)
Example URI
PUT /propdev/api/v1/proposal-person-document-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Person Document TypesPUT/propdev/api/v1/proposal-person-document-types/
Example URI
PUT /propdev/api/v1/proposal-person-document-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Person Document TypesPATCH/propdev/api/v1/proposal-person-document-types/(key)
Example URI
PATCH /propdev/api/v1/proposal-person-document-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Person Document TypesPOST/propdev/api/v1/proposal-person-document-types/
Example URI
POST /propdev/api/v1/proposal-person-document-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Person Document TypesPOST/propdev/api/v1/proposal-person-document-types/
Example URI
POST /propdev/api/v1/proposal-person-document-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Person Document Types by KeyDELETE/propdev/api/v1/proposal-person-document-types/(key)
Example URI
DELETE /propdev/api/v1/proposal-person-document-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Person Document TypesDELETE/propdev/api/v1/proposal-person-document-types/
Example URI
DELETE /propdev/api/v1/proposal-person-document-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Person Document Types with MatchingDELETE/propdev/api/v1/proposal-person-document-types/
Example URI
DELETE /propdev/api/v1/proposal-person-document-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Person Document Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Person Units ¶
Get Proposal Person Units by KeyGET/propdev/api/v1/proposal-person-units/(key)
Example URI
GET /propdev/api/v1/proposal-person-units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Person UnitsGET/propdev/api/v1/proposal-person-units/
Example URI
GET /propdev/api/v1/proposal-person-units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Person Units with FilteringGET/propdev/api/v1/proposal-person-units/
Example URI
GET /propdev/api/v1/proposal-person-units/
URI Parameters
- unitNumber
string(optional)Unit Number. Maximum length is 8.
- leadUnit
string(optional)Is Lead Unit. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Person UnitsGET/propdev/api/v1/proposal-person-units/
Example URI
GET /propdev/api/v1/proposal-person-units/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"unitNumber",
"leadUnit"
],
"primaryKey": "proposalPerson:unitNumber"
}Get Blueprint API specification for Proposal Person UnitsGET/propdev/api/v1/proposal-person-units/
Example URI
GET /propdev/api/v1/proposal-person-units/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Person Units.md"
transfer-encoding: chunkedUpdate Proposal Person UnitsPUT/propdev/api/v1/proposal-person-units/(key)
Example URI
PUT /propdev/api/v1/proposal-person-units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Person UnitsPUT/propdev/api/v1/proposal-person-units/
Example URI
PUT /propdev/api/v1/proposal-person-units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Person UnitsPATCH/propdev/api/v1/proposal-person-units/(key)
Example URI
PATCH /propdev/api/v1/proposal-person-units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Person UnitsPOST/propdev/api/v1/proposal-person-units/
Example URI
POST /propdev/api/v1/proposal-person-units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Person UnitsPOST/propdev/api/v1/proposal-person-units/
Example URI
POST /propdev/api/v1/proposal-person-units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"leadUnit": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Person Units by KeyDELETE/propdev/api/v1/proposal-person-units/(key)
Example URI
DELETE /propdev/api/v1/proposal-person-units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Person UnitsDELETE/propdev/api/v1/proposal-person-units/
Example URI
DELETE /propdev/api/v1/proposal-person-units/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Person Units with MatchingDELETE/propdev/api/v1/proposal-person-units/
Example URI
DELETE /propdev/api/v1/proposal-person-units/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- unitNumber
string(optional)Unit Number. Maximum length is 8.
- leadUnit
string(optional)Is Lead Unit. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Person Ynqs ¶
Get Proposal Person Ynqs by KeyGET/propdev/api/v1/proposal-person-ynqs/(key)
Example URI
GET /propdev/api/v1/proposal-person-ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Person YnqsGET/propdev/api/v1/proposal-person-ynqs/
Example URI
GET /propdev/api/v1/proposal-person-ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
},
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Person Ynqs with FilteringGET/propdev/api/v1/proposal-person-ynqs/
Example URI
GET /propdev/api/v1/proposal-person-ynqs/
URI Parameters
- questionId
string(optional)Question Id. Maximum length is 4.
- answer
string(optional)Answer. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
},
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Person YnqsGET/propdev/api/v1/proposal-person-ynqs/
Example URI
GET /propdev/api/v1/proposal-person-ynqs/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"questionId",
"answer"
],
"primaryKey": "proposalPerson:ynq"
}Get Blueprint API specification for Proposal Person YnqsGET/propdev/api/v1/proposal-person-ynqs/
Example URI
GET /propdev/api/v1/proposal-person-ynqs/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Person Ynqs.md"
transfer-encoding: chunkedUpdate Proposal Person YnqsPUT/propdev/api/v1/proposal-person-ynqs/(key)
Example URI
PUT /propdev/api/v1/proposal-person-ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Person YnqsPUT/propdev/api/v1/proposal-person-ynqs/
Example URI
PUT /propdev/api/v1/proposal-person-ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
},
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Person YnqsPATCH/propdev/api/v1/proposal-person-ynqs/(key)
Example URI
PATCH /propdev/api/v1/proposal-person-ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Person YnqsPOST/propdev/api/v1/proposal-person-ynqs/
Example URI
POST /propdev/api/v1/proposal-person-ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Person YnqsPOST/propdev/api/v1/proposal-person-ynqs/
Example URI
POST /propdev/api/v1/proposal-person-ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
},
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
},
{
"questionId": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Person Ynqs by KeyDELETE/propdev/api/v1/proposal-person-ynqs/(key)
Example URI
DELETE /propdev/api/v1/proposal-person-ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Person YnqsDELETE/propdev/api/v1/proposal-person-ynqs/
Example URI
DELETE /propdev/api/v1/proposal-person-ynqs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Person Ynqs with MatchingDELETE/propdev/api/v1/proposal-person-ynqs/
Example URI
DELETE /propdev/api/v1/proposal-person-ynqs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- questionId
string(optional)Question Id. Maximum length is 4.
- answer
string(optional)Answer. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Persons ¶
Get Proposal Persons by KeyGET/propdev/api/v1/proposal-persons/(key)
Example URI
GET /propdev/api/v1/proposal-persons/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"conflictOfInterestFlag": "(val)",
"otherSignificantContributorFlag": "(val)",
"percentageEffort": "(val)",
"fedrDebrFlag": "(val)",
"fedrDelqFlag": "(val)",
"includeInCreditAllocation": "(val)",
"rolodexId": "(val)",
"proposalPersonNumber": "(val)",
"proposalPersonRoleId": "(val)",
"lastNotification": "(val)",
"optInUnitStatus": "(val)",
"optInCertificationStatus": "(val)",
"projectRole": "(val)",
"ordinalPosition": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"personId": "(val)",
"socialSecurityNumber": "(val)",
"lastName": "(val)",
"firstName": "(val)",
"middleName": "(val)",
"fullName": "(val)",
"priorName": "(val)",
"userName": "(val)",
"emailAddress": "(val)",
"dateOfBirth": "(val)",
"age": "(val)",
"ageByFiscalYear": "(val)",
"gender": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"officePhone": "(val)",
"secondaryOfficeLocation": "(val)",
"secondaryOfficePhone": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"saluation": "(val)",
"countryOfCitizenship": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"homeUnit": "(val)",
"facultyFlag": "(val)",
"graduateStudentStaffFlag": "(val)",
"researchStaffFlag": "(val)",
"serviceStaffFlag": "(val)",
"supportStaffFlag": "(val)",
"otherAcademicGroupFlag": "(val)",
"medicalStaffFlag": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"county": "(val)",
"state": "(val)",
"postalCode": "(val)",
"countryCode": "(val)",
"faxNumber": "(val)",
"pagerNumber": "(val)",
"mobilePhoneNumber": "(val)",
"eraCommonsUserName": "(val)",
"nsfId": "(val)",
"division": "(val)",
"citizenshipTypeCode": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"summerEffort": "(val)",
"objectId": "(val)",
"updateUser": "(val)",
"updateTimestamp": "(val)",
"versionNumber": "(val)",
"developmentProposal.proposalNumber": "(val)",
"_primaryKey": "(val)"
}Get All Proposal PersonsGET/propdev/api/v1/proposal-persons/
Example URI
GET /propdev/api/v1/proposal-persons/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"conflictOfInterestFlag": "(val)",
"otherSignificantContributorFlag": "(val)",
"percentageEffort": "(val)",
"fedrDebrFlag": "(val)",
"fedrDelqFlag": "(val)",
"includeInCreditAllocation": "(val)",
"rolodexId": "(val)",
"proposalPersonNumber": "(val)",
"proposalPersonRoleId": "(val)",
"lastNotification": "(val)",
"optInUnitStatus": "(val)",
"optInCertificationStatus": "(val)",
"projectRole": "(val)",
"ordinalPosition": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"personId": "(val)",
"socialSecurityNumber": "(val)",
"lastName": "(val)",
"firstName": "(val)",
"middleName": "(val)",
"fullName": "(val)",
"priorName": "(val)",
"userName": "(val)",
"emailAddress": "(val)",
"dateOfBirth": "(val)",
"age": "(val)",
"ageByFiscalYear": "(val)",
"gender": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"officePhone": "(val)",
"secondaryOfficeLocation": "(val)",
"secondaryOfficePhone": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"saluation": "(val)",
"countryOfCitizenship": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"homeUnit": "(val)",
"facultyFlag": "(val)",
"graduateStudentStaffFlag": "(val)",
"researchStaffFlag": "(val)",
"serviceStaffFlag": "(val)",
"supportStaffFlag": "(val)",
"otherAcademicGroupFlag": "(val)",
"medicalStaffFlag": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"county": "(val)",
"state": "(val)",
"postalCode": "(val)",
"countryCode": "(val)",
"faxNumber": "(val)",
"pagerNumber": "(val)",
"mobilePhoneNumber": "(val)",
"eraCommonsUserName": "(val)",
"nsfId": "(val)",
"division": "(val)",
"citizenshipTypeCode": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"summerEffort": "(val)",
"objectId": "(val)",
"updateUser": "(val)",
"updateTimestamp": "(val)",
"versionNumber": "(val)",
"developmentProposal.proposalNumber": "(val)",
"_primaryKey": "(val)"
},
{
"conflictOfInterestFlag": "(val)",
"otherSignificantContributorFlag": "(val)",
"percentageEffort": "(val)",
"fedrDebrFlag": "(val)",
"fedrDelqFlag": "(val)",
"includeInCreditAllocation": "(val)",
"rolodexId": "(val)",
"proposalPersonNumber": "(val)",
"proposalPersonRoleId": "(val)",
"lastNotification": "(val)",
"optInUnitStatus": "(val)",
"optInCertificationStatus": "(val)",
"projectRole": "(val)",
"ordinalPosition": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"personId": "(val)",
"socialSecurityNumber": "(val)",
"lastName": "(val)",
"firstName": "(val)",
"middleName": "(val)",
"fullName": "(val)",
"priorName": "(val)",
"userName": "(val)",
"emailAddress": "(val)",
"dateOfBirth": "(val)",
"age": "(val)",
"ageByFiscalYear": "(val)",
"gender": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"officePhone": "(val)",
"secondaryOfficeLocation": "(val)",
"secondaryOfficePhone": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"saluation": "(val)",
"countryOfCitizenship": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"homeUnit": "(val)",
"facultyFlag": "(val)",
"graduateStudentStaffFlag": "(val)",
"researchStaffFlag": "(val)",
"serviceStaffFlag": "(val)",
"supportStaffFlag": "(val)",
"otherAcademicGroupFlag": "(val)",
"medicalStaffFlag": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"county": "(val)",
"state": "(val)",
"postalCode": "(val)",
"countryCode": "(val)",
"faxNumber": "(val)",
"pagerNumber": "(val)",
"mobilePhoneNumber": "(val)",
"eraCommonsUserName": "(val)",
"nsfId": "(val)",
"division": "(val)",
"citizenshipTypeCode": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"summerEffort": "(val)",
"objectId": "(val)",
"updateUser": "(val)",
"updateTimestamp": "(val)",
"versionNumber": "(val)",
"developmentProposal.proposalNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Persons with FilteringGET/propdev/api/v1/proposal-persons/
Example URI
GET /propdev/api/v1/proposal-persons/
URI Parameters
- conflictOfInterestFlag
string(optional)Conflict of interest. Maximum length is 1.
- otherSignificantContributorFlag
string(optional)Other Significant Contributor. Maximum length is 1.
- percentageEffort
string(optional)Total Effort. Maximum length is 20.
- fedrDebrFlag
string(optional)FedrDebr. Maximum length is 1.
- fedrDelqFlag
string(optional)FedrDelq. Maximum length is 1.
- includeInCreditAllocation
string(optional)Include In Credit Allocation.
- rolodexId
string(optional)Rolodex Id. Maximum length is 40.
- proposalPersonNumber
string(optional)Proposal Person Number. Maximum length is 40.
- proposalPersonRoleId
string(optional)Proposal Person Role Id. Maximum length is 40.
- lastNotification
string(optional)Last Notification.
- optInUnitStatus
string(optional)Opt In Unit Status.
- optInCertificationStatus
string(optional)Opt In Certification Status.
- projectRole
string(optional)Key Person Role. Maximum length is 60.
- ordinalPosition
string(optional)Ordinal Position.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
- personId
string(optional)KcPerson Id. Maximum length is 40.
- socialSecurityNumber
string(optional)Social Security Number. Maximum length is 9.
- lastName
string(optional)Last Name. Maximum length is 30.
- firstName
string(optional)First Name. Maximum length is 30.
- middleName
string(optional)Middle Name. Maximum length is 30.
- fullName
string(optional)Full Name. Maximum length is 90.
- priorName
string(optional)Prior Name. Maximum length is 30.
- userName
string(optional)User Name. Maximum length is 100.
- emailAddress
string(optional)Email Address. Maximum length is 60.
- dateOfBirth
string(optional)Date of Birth. Maximum length is 10.
- age
string(optional)Age. Maximum length is 3.
- ageByFiscalYear
string(optional)Age by Fiscal Year. Maximum length is 3.
- gender
string(optional)Gender. Maximum length is 30.
- race
string(optional)Race. Maximum length is 30.
- educationLevel
string(optional)Education Level. Maximum length is 30.
- degree
string(optional)Degree. Maximum length is 11.
- major
string(optional)Major. Maximum length is 30.
- handicappedFlag
string(optional)Is Handicapped. Maximum length is 1.
- handicapType
string(optional)Handicap Type. Maximum length is 30.
- veteranFlag
string(optional)Veteran. Maximum length is 1.
- veteranType
string(optional)Veteran Type. Maximum length is 30.
- visaCode
string(optional)Visa Code. Maximum length is 20.
- visaType
string(optional)Visa Type. Maximum length is 30.
- visaRenewalDate
string(optional)Visa Renewal Date. Maximum length is 10.
- hasVisa
string(optional)Has Visa. Maximum length is 1.
- officeLocation
string(optional)Office Location. Maximum length is 30.
- officePhone
string(optional)Office Phone. Maximum length is 20.
- secondaryOfficeLocation
string(optional)Secondary Office Location. Maximum length is 30.
- secondaryOfficePhone
string(optional)Secondary Office Phone. Maximum length is 20.
- school
string(optional)School. Maximum length is 50.
- yearGraduated
string(optional)Year Graduated. Maximum length is 30.
- directoryDepartment
string(optional)Directory Department. Maximum length is 30.
- saluation
string(optional)Salutation. Maximum length is 30.
- countryOfCitizenship
string(optional)Country Code. Maximum length is 3.
- primaryTitle
string(optional)PrimaryTitle. Maximum length is 51.
- directoryTitle
string(optional)Directory Title. Maximum length is 50.
- homeUnit
string(optional)Home Unit. Maximum length is 20.
- facultyFlag
string(optional)Faculty. Maximum length is 1.
- graduateStudentStaffFlag
string(optional)Create User. Maximum length is 1.
- researchStaffFlag
string(optional)Is Research Staff. Maximum length is 1.
- serviceStaffFlag
string(optional)Is Service Staff. Maximum length is 1.
- supportStaffFlag
string(optional)Is Support Staff. Maximum length is 1.
- otherAcademicGroupFlag
string(optional)Is Other Academic Group. Maximum length is 1.
- medicalStaffFlag
string(optional)Is Medical Staff. Maximum length is 1.
- vacationAccrualFlag
string(optional)Is Vacation Accrual. Maximum length is 1.
- onSabbaticalFlag
string(optional)Is on Sabbatical. Maximum length is 1.
- idProvided
string(optional)Id Provided. Maximum length is 30.
- idVerified
string(optional)PI Eligible. Maximum length is 30.
- addressLine1
string(optional)Address Line 1. Maximum length is 80.
- addressLine2
string(optional)Address Line 2. Maximum length is 80.
- addressLine3
string(optional)Address Line 3. Maximum length is 80.
- city
string(optional)City. Maximum length is 30.
- county
string(optional)County. Maximum length is 30.
- state
string(optional)State. Maximum length is 30.
- postalCode
string(optional)Postal Code. Maximum length is 15.
- countryCode
string(optional)Country Code. Maximum length is 3.
- faxNumber
string(optional)Fax Number. Maximum length is 20.
- pagerNumber
string(optional)Page Number. Maximum length is 20.
- mobilePhoneNumber
string(optional)Moble Phone Number. Maximum length is 20.
- eraCommonsUserName
string(optional)Era Commons User Name. Maximum length is 20.
- nsfId
string(optional)NSF ID. Maximum length is 12. Minimum length is 9.
- division
string(optional)Division. Maximum length is 100.
- citizenshipTypeCode
string(optional)Citzenship Type. Maximum length is 3.
- academicYearEffort
string(optional)Academic Year Effort. Maximum length is 7.
- calendarYearEffort
string(optional)Calendar Year Effort. Maximum length is 7.
- summerEffort
string(optional)Summer Effort. Maximum length is 7.
- objectId
string(optional)- updateUser
string(optional)Update User.
- updateTimestamp
string(optional)Update Timestamp.
- versionNumber
string(optional)The assigned version number. Maximum length is 8.
- developmentProposal.proposalNumber
string(optional)The Proposal Development Number.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"conflictOfInterestFlag": "(val)",
"otherSignificantContributorFlag": "(val)",
"percentageEffort": "(val)",
"fedrDebrFlag": "(val)",
"fedrDelqFlag": "(val)",
"includeInCreditAllocation": "(val)",
"rolodexId": "(val)",
"proposalPersonNumber": "(val)",
"proposalPersonRoleId": "(val)",
"lastNotification": "(val)",
"optInUnitStatus": "(val)",
"optInCertificationStatus": "(val)",
"projectRole": "(val)",
"ordinalPosition": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"personId": "(val)",
"socialSecurityNumber": "(val)",
"lastName": "(val)",
"firstName": "(val)",
"middleName": "(val)",
"fullName": "(val)",
"priorName": "(val)",
"userName": "(val)",
"emailAddress": "(val)",
"dateOfBirth": "(val)",
"age": "(val)",
"ageByFiscalYear": "(val)",
"gender": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"officePhone": "(val)",
"secondaryOfficeLocation": "(val)",
"secondaryOfficePhone": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"saluation": "(val)",
"countryOfCitizenship": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"homeUnit": "(val)",
"facultyFlag": "(val)",
"graduateStudentStaffFlag": "(val)",
"researchStaffFlag": "(val)",
"serviceStaffFlag": "(val)",
"supportStaffFlag": "(val)",
"otherAcademicGroupFlag": "(val)",
"medicalStaffFlag": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"county": "(val)",
"state": "(val)",
"postalCode": "(val)",
"countryCode": "(val)",
"faxNumber": "(val)",
"pagerNumber": "(val)",
"mobilePhoneNumber": "(val)",
"eraCommonsUserName": "(val)",
"nsfId": "(val)",
"division": "(val)",
"citizenshipTypeCode": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"summerEffort": "(val)",
"objectId": "(val)",
"updateUser": "(val)",
"updateTimestamp": "(val)",
"versionNumber": "(val)",
"developmentProposal.proposalNumber": "(val)",
"_primaryKey": "(val)"
},
{
"conflictOfInterestFlag": "(val)",
"otherSignificantContributorFlag": "(val)",
"percentageEffort": "(val)",
"fedrDebrFlag": "(val)",
"fedrDelqFlag": "(val)",
"includeInCreditAllocation": "(val)",
"rolodexId": "(val)",
"proposalPersonNumber": "(val)",
"proposalPersonRoleId": "(val)",
"lastNotification": "(val)",
"optInUnitStatus": "(val)",
"optInCertificationStatus": "(val)",
"projectRole": "(val)",
"ordinalPosition": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"personId": "(val)",
"socialSecurityNumber": "(val)",
"lastName": "(val)",
"firstName": "(val)",
"middleName": "(val)",
"fullName": "(val)",
"priorName": "(val)",
"userName": "(val)",
"emailAddress": "(val)",
"dateOfBirth": "(val)",
"age": "(val)",
"ageByFiscalYear": "(val)",
"gender": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"officePhone": "(val)",
"secondaryOfficeLocation": "(val)",
"secondaryOfficePhone": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"saluation": "(val)",
"countryOfCitizenship": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"homeUnit": "(val)",
"facultyFlag": "(val)",
"graduateStudentStaffFlag": "(val)",
"researchStaffFlag": "(val)",
"serviceStaffFlag": "(val)",
"supportStaffFlag": "(val)",
"otherAcademicGroupFlag": "(val)",
"medicalStaffFlag": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"county": "(val)",
"state": "(val)",
"postalCode": "(val)",
"countryCode": "(val)",
"faxNumber": "(val)",
"pagerNumber": "(val)",
"mobilePhoneNumber": "(val)",
"eraCommonsUserName": "(val)",
"nsfId": "(val)",
"division": "(val)",
"citizenshipTypeCode": "(val)",
"academicYearEffort": "(val)",
"calendarYearEffort": "(val)",
"summerEffort": "(val)",
"objectId": "(val)",
"updateUser": "(val)",
"updateTimestamp": "(val)",
"versionNumber": "(val)",
"developmentProposal.proposalNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal PersonsGET/propdev/api/v1/proposal-persons/
Example URI
GET /propdev/api/v1/proposal-persons/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"conflictOfInterestFlag",
"otherSignificantContributorFlag",
"percentageEffort",
"fedrDebrFlag",
"fedrDelqFlag",
"includeInCreditAllocation",
"rolodexId",
"proposalPersonNumber",
"proposalPersonRoleId",
"lastNotification",
"optInUnitStatus",
"optInCertificationStatus",
"projectRole",
"ordinalPosition",
"hierarchyProposalNumber",
"hiddenInHierarchy",
"personId",
"socialSecurityNumber",
"lastName",
"firstName",
"middleName",
"fullName",
"priorName",
"userName",
"emailAddress",
"dateOfBirth",
"age",
"ageByFiscalYear",
"gender",
"race",
"educationLevel",
"degree",
"major",
"handicappedFlag",
"handicapType",
"veteranFlag",
"veteranType",
"visaCode",
"visaType",
"visaRenewalDate",
"hasVisa",
"officeLocation",
"officePhone",
"secondaryOfficeLocation",
"secondaryOfficePhone",
"school",
"yearGraduated",
"directoryDepartment",
"saluation",
"countryOfCitizenship",
"primaryTitle",
"directoryTitle",
"homeUnit",
"facultyFlag",
"graduateStudentStaffFlag",
"researchStaffFlag",
"serviceStaffFlag",
"supportStaffFlag",
"otherAcademicGroupFlag",
"medicalStaffFlag",
"vacationAccrualFlag",
"onSabbaticalFlag",
"idProvided",
"idVerified",
"addressLine1",
"addressLine2",
"addressLine3",
"city",
"county",
"state",
"postalCode",
"countryCode",
"faxNumber",
"pagerNumber",
"mobilePhoneNumber",
"eraCommonsUserName",
"nsfId",
"division",
"citizenshipTypeCode",
"academicYearEffort",
"calendarYearEffort",
"summerEffort",
"objectId",
"updateUser",
"updateTimestamp",
"versionNumber",
"developmentProposal.proposalNumber"
],
"primaryKey": "developmentProposal.proposalNumber:proposalPersonNumber"
}Get Blueprint API specification for Proposal PersonsGET/propdev/api/v1/proposal-persons/
Example URI
GET /propdev/api/v1/proposal-persons/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Persons.md"
transfer-encoding: chunkedProposal Role Templates ¶
Get Proposal Role Templates by KeyGET/propdev/api/v1/proposal-role-templates/(key)
Example URI
GET /propdev/api/v1/proposal-role-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Role TemplatesGET/propdev/api/v1/proposal-role-templates/
Example URI
GET /propdev/api/v1/proposal-role-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Role Templates with FilteringGET/propdev/api/v1/proposal-role-templates/
Example URI
GET /propdev/api/v1/proposal-role-templates/
URI Parameters
- id
string(optional)Id. Maximum length is 8.
- personId
string(optional)KcPerson Id. Maximum length is 40.
- roleName
string(optional)Role Name. Maximum length is 500.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Role TemplatesGET/propdev/api/v1/proposal-role-templates/
Example URI
GET /propdev/api/v1/proposal-role-templates/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"personId",
"roleName",
"unitNumber",
"active"
],
"primaryKey": "id"
}Get Blueprint API specification for Proposal Role TemplatesGET/propdev/api/v1/proposal-role-templates/
Example URI
GET /propdev/api/v1/proposal-role-templates/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Role Templates.md"
transfer-encoding: chunkedUpdate Proposal Role TemplatesPUT/propdev/api/v1/proposal-role-templates/(key)
Example URI
PUT /propdev/api/v1/proposal-role-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Role TemplatesPUT/propdev/api/v1/proposal-role-templates/
Example URI
PUT /propdev/api/v1/proposal-role-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Role TemplatesPATCH/propdev/api/v1/proposal-role-templates/(key)
Example URI
PATCH /propdev/api/v1/proposal-role-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Role TemplatesPOST/propdev/api/v1/proposal-role-templates/
Example URI
POST /propdev/api/v1/proposal-role-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Role TemplatesPOST/propdev/api/v1/proposal-role-templates/
Example URI
POST /propdev/api/v1/proposal-role-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"personId": "(val)",
"roleName": "(val)",
"unitNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Role Templates by KeyDELETE/propdev/api/v1/proposal-role-templates/(key)
Example URI
DELETE /propdev/api/v1/proposal-role-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Role TemplatesDELETE/propdev/api/v1/proposal-role-templates/
Example URI
DELETE /propdev/api/v1/proposal-role-templates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Role Templates with MatchingDELETE/propdev/api/v1/proposal-role-templates/
Example URI
DELETE /propdev/api/v1/proposal-role-templates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Id. Maximum length is 8.
- personId
string(optional)KcPerson Id. Maximum length is 40.
- roleName
string(optional)Role Name. Maximum length is 500.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Sites ¶
Get Proposal Sites by KeyGET/propdev/api/v1/proposal-sites/(key)
Example URI
GET /propdev/api/v1/proposal-sites/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}Get All Proposal SitesGET/propdev/api/v1/proposal-sites/
Example URI
GET /propdev/api/v1/proposal-sites/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Sites with FilteringGET/propdev/api/v1/proposal-sites/
Example URI
GET /propdev/api/v1/proposal-sites/
URI Parameters
- siteNumber
string(optional)The site number within the proposal. Maximum length is 3.
- locationName
string(optional)The name to display for the Proposal Site; may differ from the name in the rolodex. Maximum length is 60.
- locationTypeCode
string(optional)The type of location (applicant org., performing org., etc.). Maximum length is 3.
- organizationId
string(optional)This is the foreign key into the Organization. Maximum length is 8.
- rolodexId
string(optional)Rolodex Id. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal SitesGET/propdev/api/v1/proposal-sites/
Example URI
GET /propdev/api/v1/proposal-sites/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"siteNumber",
"locationName",
"locationTypeCode",
"organizationId",
"rolodexId"
],
"primaryKey": "developmentProposal:siteNumber"
}Get Blueprint API specification for Proposal SitesGET/propdev/api/v1/proposal-sites/
Example URI
GET /propdev/api/v1/proposal-sites/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Sites.md"
transfer-encoding: chunkedUpdate Proposal SitesPUT/propdev/api/v1/proposal-sites/(key)
Example URI
PUT /propdev/api/v1/proposal-sites/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal SitesPUT/propdev/api/v1/proposal-sites/
Example URI
PUT /propdev/api/v1/proposal-sites/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal SitesPATCH/propdev/api/v1/proposal-sites/(key)
Example URI
PATCH /propdev/api/v1/proposal-sites/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}Insert Proposal SitesPOST/propdev/api/v1/proposal-sites/
Example URI
POST /propdev/api/v1/proposal-sites/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal SitesPOST/propdev/api/v1/proposal-sites/
Example URI
POST /propdev/api/v1/proposal-sites/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"siteNumber": "(val)",
"locationName": "(val)",
"locationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Sites by KeyDELETE/propdev/api/v1/proposal-sites/(key)
Example URI
DELETE /propdev/api/v1/proposal-sites/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal SitesDELETE/propdev/api/v1/proposal-sites/
Example URI
DELETE /propdev/api/v1/proposal-sites/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Sites with MatchingDELETE/propdev/api/v1/proposal-sites/
Example URI
DELETE /propdev/api/v1/proposal-sites/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- siteNumber
string(optional)The site number within the proposal. Maximum length is 3.
- locationName
string(optional)The name to display for the Proposal Site; may differ from the name in the rolodex. Maximum length is 60.
- locationTypeCode
string(optional)The type of location (applicant org., performing org., etc.). Maximum length is 3.
- organizationId
string(optional)This is the foreign key into the Organization. Maximum length is 8.
- rolodexId
string(optional)Rolodex Id. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Special Review Exemptions ¶
Get Proposal Special Review Exemptions by KeyGET/propdev/api/v1/proposal-special-review-exemptions/(key)
Example URI
GET /propdev/api/v1/proposal-special-review-exemptions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Special Review ExemptionsGET/propdev/api/v1/proposal-special-review-exemptions/
Example URI
GET /propdev/api/v1/proposal-special-review-exemptions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Special Review Exemptions with FilteringGET/propdev/api/v1/proposal-special-review-exemptions/
Example URI
GET /propdev/api/v1/proposal-special-review-exemptions/
URI Parameters
- id
string(optional)Proposal Special Review Exemption Id. Maximum length is 22.
- exemptionTypeCode
string(optional)Exemption #. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Special Review ExemptionsGET/propdev/api/v1/proposal-special-review-exemptions/
Example URI
GET /propdev/api/v1/proposal-special-review-exemptions/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"exemptionTypeCode"
],
"primaryKey": "id"
}Get Blueprint API specification for Proposal Special Review ExemptionsGET/propdev/api/v1/proposal-special-review-exemptions/
Example URI
GET /propdev/api/v1/proposal-special-review-exemptions/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Special Review Exemptions.md"
transfer-encoding: chunkedUpdate Proposal Special Review ExemptionsPUT/propdev/api/v1/proposal-special-review-exemptions/(key)
Example URI
PUT /propdev/api/v1/proposal-special-review-exemptions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Special Review ExemptionsPUT/propdev/api/v1/proposal-special-review-exemptions/
Example URI
PUT /propdev/api/v1/proposal-special-review-exemptions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Special Review ExemptionsPATCH/propdev/api/v1/proposal-special-review-exemptions/(key)
Example URI
PATCH /propdev/api/v1/proposal-special-review-exemptions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Special Review ExemptionsPOST/propdev/api/v1/proposal-special-review-exemptions/
Example URI
POST /propdev/api/v1/proposal-special-review-exemptions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Special Review ExemptionsPOST/propdev/api/v1/proposal-special-review-exemptions/
Example URI
POST /propdev/api/v1/proposal-special-review-exemptions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"exemptionTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Special Review Exemptions by KeyDELETE/propdev/api/v1/proposal-special-review-exemptions/(key)
Example URI
DELETE /propdev/api/v1/proposal-special-review-exemptions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Special Review ExemptionsDELETE/propdev/api/v1/proposal-special-review-exemptions/
Example URI
DELETE /propdev/api/v1/proposal-special-review-exemptions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Special Review Exemptions with MatchingDELETE/propdev/api/v1/proposal-special-review-exemptions/
Example URI
DELETE /propdev/api/v1/proposal-special-review-exemptions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Proposal Special Review Exemption Id. Maximum length is 22.
- exemptionTypeCode
string(optional)Exemption #. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Special Reviews ¶
Get Proposal Special Reviews by KeyGET/propdev/api/v1/proposal-special-reviews/(key)
Example URI
GET /propdev/api/v1/proposal-special-reviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Special ReviewsGET/propdev/api/v1/proposal-special-reviews/
Example URI
GET /propdev/api/v1/proposal-special-reviews/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Special Reviews with FilteringGET/propdev/api/v1/proposal-special-reviews/
Example URI
GET /propdev/api/v1/proposal-special-reviews/
URI Parameters
- id
string(optional)Proposal Special Review Id. Maximum length is 22.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
- approvalTypeCode
string(optional)Approval Status Type Code. Maximum length is 3.
- approvalDate
string(optional)Approval Date. Maximum length is 10.
- comments
string(optional)Comments. Maximum length is 2000.
- protocolStatus
string(optional)Protocol Status.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- specialReviewTypeCode
string(optional)Special Review Type Code. Maximum length is 3.
- specialReviewNumber
string(optional)Special Review Number. Maximum length is 22.
- applicationDate
string(optional)Application Date. Maximum length is 10.
- expirationDate
string(optional)Expiration Date. Maximum length is 10.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Special ReviewsGET/propdev/api/v1/proposal-special-reviews/
Example URI
GET /propdev/api/v1/proposal-special-reviews/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"hierarchyProposalNumber",
"hiddenInHierarchy",
"approvalTypeCode",
"approvalDate",
"comments",
"protocolStatus",
"protocolNumber",
"specialReviewTypeCode",
"specialReviewNumber",
"applicationDate",
"expirationDate"
],
"primaryKey": "id"
}Get Blueprint API specification for Proposal Special ReviewsGET/propdev/api/v1/proposal-special-reviews/
Example URI
GET /propdev/api/v1/proposal-special-reviews/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Special Reviews.md"
transfer-encoding: chunkedUpdate Proposal Special ReviewsPUT/propdev/api/v1/proposal-special-reviews/(key)
Example URI
PUT /propdev/api/v1/proposal-special-reviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Special ReviewsPUT/propdev/api/v1/proposal-special-reviews/
Example URI
PUT /propdev/api/v1/proposal-special-reviews/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Special ReviewsPATCH/propdev/api/v1/proposal-special-reviews/(key)
Example URI
PATCH /propdev/api/v1/proposal-special-reviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Special ReviewsPOST/propdev/api/v1/proposal-special-reviews/
Example URI
POST /propdev/api/v1/proposal-special-reviews/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Special ReviewsPOST/propdev/api/v1/proposal-special-reviews/
Example URI
POST /propdev/api/v1/proposal-special-reviews/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"approvalTypeCode": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"protocolStatus": "(val)",
"protocolNumber": "(val)",
"specialReviewTypeCode": "(val)",
"specialReviewNumber": "(val)",
"applicationDate": "(val)",
"expirationDate": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Special Reviews by KeyDELETE/propdev/api/v1/proposal-special-reviews/(key)
Example URI
DELETE /propdev/api/v1/proposal-special-reviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Special ReviewsDELETE/propdev/api/v1/proposal-special-reviews/
Example URI
DELETE /propdev/api/v1/proposal-special-reviews/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Special Reviews with MatchingDELETE/propdev/api/v1/proposal-special-reviews/
Example URI
DELETE /propdev/api/v1/proposal-special-reviews/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Proposal Special Review Id. Maximum length is 22.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
- approvalTypeCode
string(optional)Approval Status Type Code. Maximum length is 3.
- approvalDate
string(optional)Approval Date. Maximum length is 10.
- comments
string(optional)Comments. Maximum length is 2000.
- protocolStatus
string(optional)Protocol Status.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- specialReviewTypeCode
string(optional)Special Review Type Code. Maximum length is 3.
- specialReviewNumber
string(optional)Special Review Number. Maximum length is 22.
- applicationDate
string(optional)Application Date. Maximum length is 10.
- expirationDate
string(optional)Expiration Date. Maximum length is 10.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal States ¶
Get Proposal States by KeyGET/propdev/api/v1/proposal-states/(key)
Example URI
GET /propdev/api/v1/proposal-states/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Proposal StatesGET/propdev/api/v1/proposal-states/
Example URI
GET /propdev/api/v1/proposal-states/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal States with FilteringGET/propdev/api/v1/proposal-states/
Example URI
GET /propdev/api/v1/proposal-states/
URI Parameters
- code
string(optional)Proposal State Type Code. Maximum length is 2.
- description
string(optional)Description. Maximum length is 40.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal StatesGET/propdev/api/v1/proposal-states/
Example URI
GET /propdev/api/v1/proposal-states/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Proposal StatesGET/propdev/api/v1/proposal-states/
Example URI
GET /propdev/api/v1/proposal-states/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal States.md"
transfer-encoding: chunkedUpdate Proposal StatesPUT/propdev/api/v1/proposal-states/(key)
Example URI
PUT /propdev/api/v1/proposal-states/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal StatesPUT/propdev/api/v1/proposal-states/
Example URI
PUT /propdev/api/v1/proposal-states/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal StatesPATCH/propdev/api/v1/proposal-states/(key)
Example URI
PATCH /propdev/api/v1/proposal-states/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Proposal StatesPOST/propdev/api/v1/proposal-states/
Example URI
POST /propdev/api/v1/proposal-states/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal StatesPOST/propdev/api/v1/proposal-states/
Example URI
POST /propdev/api/v1/proposal-states/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal States by KeyDELETE/propdev/api/v1/proposal-states/(key)
Example URI
DELETE /propdev/api/v1/proposal-states/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal StatesDELETE/propdev/api/v1/proposal-states/
Example URI
DELETE /propdev/api/v1/proposal-states/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal States with MatchingDELETE/propdev/api/v1/proposal-states/
Example URI
DELETE /propdev/api/v1/proposal-states/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Proposal State Type Code. Maximum length is 2.
- description
string(optional)Description. Maximum length is 40.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Unit Credit Splits ¶
Get Proposal Unit Credit Splits by KeyGET/propdev/api/v1/proposal-unit-credit-splits/(key)
Example URI
GET /propdev/api/v1/proposal-unit-credit-splits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}Get All Proposal Unit Credit SplitsGET/propdev/api/v1/proposal-unit-credit-splits/
Example URI
GET /propdev/api/v1/proposal-unit-credit-splits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
},
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Unit Credit Splits with FilteringGET/propdev/api/v1/proposal-unit-credit-splits/
Example URI
GET /propdev/api/v1/proposal-unit-credit-splits/
URI Parameters
- invCreditTypeCode
string(optional)Investigator Credit Type Code. Maximum length is 3.
- credit
string(optional)Credit. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
},
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal Unit Credit SplitsGET/propdev/api/v1/proposal-unit-credit-splits/
Example URI
GET /propdev/api/v1/proposal-unit-credit-splits/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"invCreditTypeCode",
"credit"
],
"primaryKey": "invCreditTypeCode:proposalPersonUnit"
}Get Blueprint API specification for Proposal Unit Credit SplitsGET/propdev/api/v1/proposal-unit-credit-splits/
Example URI
GET /propdev/api/v1/proposal-unit-credit-splits/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Unit Credit Splits.md"
transfer-encoding: chunkedUpdate Proposal Unit Credit SplitsPUT/propdev/api/v1/proposal-unit-credit-splits/(key)
Example URI
PUT /propdev/api/v1/proposal-unit-credit-splits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal Unit Credit SplitsPUT/propdev/api/v1/proposal-unit-credit-splits/
Example URI
PUT /propdev/api/v1/proposal-unit-credit-splits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
},
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal Unit Credit SplitsPATCH/propdev/api/v1/proposal-unit-credit-splits/(key)
Example URI
PATCH /propdev/api/v1/proposal-unit-credit-splits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}Insert Proposal Unit Credit SplitsPOST/propdev/api/v1/proposal-unit-credit-splits/
Example URI
POST /propdev/api/v1/proposal-unit-credit-splits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal Unit Credit SplitsPOST/propdev/api/v1/proposal-unit-credit-splits/
Example URI
POST /propdev/api/v1/proposal-unit-credit-splits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
},
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
},
{
"invCreditTypeCode": "(val)",
"credit": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Unit Credit Splits by KeyDELETE/propdev/api/v1/proposal-unit-credit-splits/(key)
Example URI
DELETE /propdev/api/v1/proposal-unit-credit-splits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Unit Credit SplitsDELETE/propdev/api/v1/proposal-unit-credit-splits/
Example URI
DELETE /propdev/api/v1/proposal-unit-credit-splits/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Unit Credit Splits with MatchingDELETE/propdev/api/v1/proposal-unit-credit-splits/
Example URI
DELETE /propdev/api/v1/proposal-unit-credit-splits/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- invCreditTypeCode
string(optional)Investigator Credit Type Code. Maximum length is 3.
- credit
string(optional)Credit. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Ynqs ¶
Get Proposal Ynqs by KeyGET/propdev/api/v1/proposal-ynqs/(key)
Example URI
GET /propdev/api/v1/proposal-ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Get All Proposal YnqsGET/propdev/api/v1/proposal-ynqs/
Example URI
GET /propdev/api/v1/proposal-ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Ynqs with FilteringGET/propdev/api/v1/proposal-ynqs/
Example URI
GET /propdev/api/v1/proposal-ynqs/
URI Parameters
- proposalNumber
string(optional)Proposal Number. Maximum length is 8.
- questionId
string(optional)Question Id. Maximum length is 4.
- answer
string(optional)Answer. Maximum length is 1.
- explanation
string(optional)Explanation. Maximum length is 400.
- reviewDate
string(optional)Review Date. Maximum length is 21.
- sortId
string(optional)Sort Id.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal YnqsGET/propdev/api/v1/proposal-ynqs/
Example URI
GET /propdev/api/v1/proposal-ynqs/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"proposalNumber",
"questionId",
"answer",
"explanation",
"reviewDate",
"sortId"
],
"primaryKey": "proposalNumber:questionId"
}Get Blueprint API specification for Proposal YnqsGET/propdev/api/v1/proposal-ynqs/
Example URI
GET /propdev/api/v1/proposal-ynqs/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Ynqs.md"
transfer-encoding: chunkedUpdate Proposal YnqsPUT/propdev/api/v1/proposal-ynqs/(key)
Example URI
PUT /propdev/api/v1/proposal-ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal YnqsPUT/propdev/api/v1/proposal-ynqs/
Example URI
PUT /propdev/api/v1/proposal-ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal YnqsPATCH/propdev/api/v1/proposal-ynqs/(key)
Example URI
PATCH /propdev/api/v1/proposal-ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Insert Proposal YnqsPOST/propdev/api/v1/proposal-ynqs/
Example URI
POST /propdev/api/v1/proposal-ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal YnqsPOST/propdev/api/v1/proposal-ynqs/
Example URI
POST /propdev/api/v1/proposal-ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Ynqs by KeyDELETE/propdev/api/v1/proposal-ynqs/(key)
Example URI
DELETE /propdev/api/v1/proposal-ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal YnqsDELETE/propdev/api/v1/proposal-ynqs/
Example URI
DELETE /propdev/api/v1/proposal-ynqs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Ynqs with MatchingDELETE/propdev/api/v1/proposal-ynqs/
Example URI
DELETE /propdev/api/v1/proposal-ynqs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- proposalNumber
string(optional)Proposal Number. Maximum length is 8.
- questionId
string(optional)Question Id. Maximum length is 4.
- answer
string(optional)Answer. Maximum length is 1.
- explanation
string(optional)Explanation. Maximum length is 400.
- reviewDate
string(optional)Review Date. Maximum length is 21.
- sortId
string(optional)Sort Id.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s Application Attachments ¶
Get S2s Application Attachments by KeyGET/propdev/api/v1/s2s-application-attachments/(key)
Example URI
GET /propdev/api/v1/s2s-application-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
}Get All S2s Application AttachmentsGET/propdev/api/v1/s2s-application-attachments/
Example URI
GET /propdev/api/v1/s2s-application-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s Application Attachments with FilteringGET/propdev/api/v1/s2s-application-attachments/
Example URI
GET /propdev/api/v1/s2s-application-attachments/
URI Parameters
- id
string(optional)Id.
- contentId
string(optional)Attachments. Maximum length is 255.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8.
- contentType
string(optional)Content Type. Maximum length is 30.
- hashCode
string(optional)Hash Code. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s Application AttachmentsGET/propdev/api/v1/s2s-application-attachments/
Example URI
GET /propdev/api/v1/s2s-application-attachments/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"contentId",
"proposalNumber",
"contentType",
"hashCode"
],
"primaryKey": "contentId:id:proposalNumber"
}Get Blueprint API specification for S2s Application AttachmentsGET/propdev/api/v1/s2s-application-attachments/
Example URI
GET /propdev/api/v1/s2s-application-attachments/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s Application Attachments.md"
transfer-encoding: chunkedUpdate S2s Application AttachmentsPUT/propdev/api/v1/s2s-application-attachments/(key)
Example URI
PUT /propdev/api/v1/s2s-application-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s Application AttachmentsPUT/propdev/api/v1/s2s-application-attachments/
Example URI
PUT /propdev/api/v1/s2s-application-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s Application AttachmentsPATCH/propdev/api/v1/s2s-application-attachments/(key)
Example URI
PATCH /propdev/api/v1/s2s-application-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
}Insert S2s Application AttachmentsPOST/propdev/api/v1/s2s-application-attachments/
Example URI
POST /propdev/api/v1/s2s-application-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s Application AttachmentsPOST/propdev/api/v1/s2s-application-attachments/
Example URI
POST /propdev/api/v1/s2s-application-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"contentId": "(val)",
"proposalNumber": "(val)",
"contentType": "(val)",
"hashCode": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s Application Attachments by KeyDELETE/propdev/api/v1/s2s-application-attachments/(key)
Example URI
DELETE /propdev/api/v1/s2s-application-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Application AttachmentsDELETE/propdev/api/v1/s2s-application-attachments/
Example URI
DELETE /propdev/api/v1/s2s-application-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Application Attachments with MatchingDELETE/propdev/api/v1/s2s-application-attachments/
Example URI
DELETE /propdev/api/v1/s2s-application-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Id.
- contentId
string(optional)Attachments. Maximum length is 255.
- proposalNumber
string(optional)Proposal Number. Maximum length is 8.
- contentType
string(optional)Content Type. Maximum length is 30.
- hashCode
string(optional)Hash Code. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s Application Submissions ¶
Get S2s Application Submissions by KeyGET/propdev/api/v1/s2s-application-submissions/(key)
Example URI
GET /propdev/api/v1/s2s-application-submissions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}Get All S2s Application SubmissionsGET/propdev/api/v1/s2s-application-submissions/
Example URI
GET /propdev/api/v1/s2s-application-submissions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s Application Submissions with FilteringGET/propdev/api/v1/s2s-application-submissions/
Example URI
GET /propdev/api/v1/s2s-application-submissions/
URI Parameters
- proposalNumber
string(optional)Proposal Number. Maximum length is 8.
- submissionNumber
string(optional)Submission Number. Maximum length is 3.
- agencyTrackingId
string(optional)Agency Tracking Id. Maximum length is 50.
- comments
string(optional)Comments. Maximum length is 2000.
- ggTrackingId
string(optional)S2S Tracking Id. Maximum length is 50.
- lastModifiedDate
string(optional)This attribute should always be overriden on the descriptive elements. Maximum length is 21.
- lastNotifiedDate
string(optional)This attribute should always be overriden on the descriptive elements. Maximum length is 21.
- receivedDate
string(optional)This attribute should always be overriden on the descriptive elements. Maximum length is 21.
- status
string(optional)Status. Maximum length is 50.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s Application SubmissionsGET/propdev/api/v1/s2s-application-submissions/
Example URI
GET /propdev/api/v1/s2s-application-submissions/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"proposalNumber",
"submissionNumber",
"agencyTrackingId",
"comments",
"ggTrackingId",
"lastModifiedDate",
"lastNotifiedDate",
"receivedDate",
"status"
],
"primaryKey": "proposalNumber:submissionNumber"
}Get Blueprint API specification for S2s Application SubmissionsGET/propdev/api/v1/s2s-application-submissions/
Example URI
GET /propdev/api/v1/s2s-application-submissions/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s Application Submissions.md"
transfer-encoding: chunkedUpdate S2s Application SubmissionsPUT/propdev/api/v1/s2s-application-submissions/(key)
Example URI
PUT /propdev/api/v1/s2s-application-submissions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s Application SubmissionsPUT/propdev/api/v1/s2s-application-submissions/
Example URI
PUT /propdev/api/v1/s2s-application-submissions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s Application SubmissionsPATCH/propdev/api/v1/s2s-application-submissions/(key)
Example URI
PATCH /propdev/api/v1/s2s-application-submissions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}Insert S2s Application SubmissionsPOST/propdev/api/v1/s2s-application-submissions/
Example URI
POST /propdev/api/v1/s2s-application-submissions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s Application SubmissionsPOST/propdev/api/v1/s2s-application-submissions/
Example URI
POST /propdev/api/v1/s2s-application-submissions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"submissionNumber": "(val)",
"agencyTrackingId": "(val)",
"comments": "(val)",
"ggTrackingId": "(val)",
"lastModifiedDate": "(val)",
"lastNotifiedDate": "(val)",
"receivedDate": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s Application Submissions by KeyDELETE/propdev/api/v1/s2s-application-submissions/(key)
Example URI
DELETE /propdev/api/v1/s2s-application-submissions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Application SubmissionsDELETE/propdev/api/v1/s2s-application-submissions/
Example URI
DELETE /propdev/api/v1/s2s-application-submissions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Application Submissions with MatchingDELETE/propdev/api/v1/s2s-application-submissions/
Example URI
DELETE /propdev/api/v1/s2s-application-submissions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- proposalNumber
string(optional)Proposal Number. Maximum length is 8.
- submissionNumber
string(optional)Submission Number. Maximum length is 3.
- agencyTrackingId
string(optional)Agency Tracking Id. Maximum length is 50.
- comments
string(optional)Comments. Maximum length is 2000.
- ggTrackingId
string(optional)S2S Tracking Id. Maximum length is 50.
- lastModifiedDate
string(optional)This attribute should always be overriden on the descriptive elements. Maximum length is 21.
- lastNotifiedDate
string(optional)This attribute should always be overriden on the descriptive elements. Maximum length is 21.
- receivedDate
string(optional)This attribute should always be overriden on the descriptive elements. Maximum length is 21.
- status
string(optional)Status. Maximum length is 50.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s Applications ¶
Get S2s Applications by KeyGET/propdev/api/v1/s2s-applications/(key)
Example URI
GET /propdev/api/v1/s2s-applications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
}Get All S2s ApplicationsGET/propdev/api/v1/s2s-applications/
Example URI
GET /propdev/api/v1/s2s-applications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s Applications with FilteringGET/propdev/api/v1/s2s-applications/
Example URI
GET /propdev/api/v1/s2s-applications/
URI Parameters
- proposalNumber
string(optional)Proposal Number. Maximum length is 8.
- application
string(optional)Application.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s ApplicationsGET/propdev/api/v1/s2s-applications/
Example URI
GET /propdev/api/v1/s2s-applications/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"proposalNumber",
"application"
],
"primaryKey": "proposalNumber"
}Get Blueprint API specification for S2s ApplicationsGET/propdev/api/v1/s2s-applications/
Example URI
GET /propdev/api/v1/s2s-applications/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s Applications.md"
transfer-encoding: chunkedUpdate S2s ApplicationsPUT/propdev/api/v1/s2s-applications/(key)
Example URI
PUT /propdev/api/v1/s2s-applications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s ApplicationsPUT/propdev/api/v1/s2s-applications/
Example URI
PUT /propdev/api/v1/s2s-applications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s ApplicationsPATCH/propdev/api/v1/s2s-applications/(key)
Example URI
PATCH /propdev/api/v1/s2s-applications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
}Insert S2s ApplicationsPOST/propdev/api/v1/s2s-applications/
Example URI
POST /propdev/api/v1/s2s-applications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s ApplicationsPOST/propdev/api/v1/s2s-applications/
Example URI
POST /propdev/api/v1/s2s-applications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
},
{
"proposalNumber": "(val)",
"application": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s Applications by KeyDELETE/propdev/api/v1/s2s-applications/(key)
Example URI
DELETE /propdev/api/v1/s2s-applications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s ApplicationsDELETE/propdev/api/v1/s2s-applications/
Example URI
DELETE /propdev/api/v1/s2s-applications/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Applications with MatchingDELETE/propdev/api/v1/s2s-applications/
Example URI
DELETE /propdev/api/v1/s2s-applications/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- proposalNumber
string(optional)Proposal Number. Maximum length is 8.
- application
string(optional)Application.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s Errors ¶
Get S2s Errors by KeyGET/propdev/api/v1/s2s-errors/(key)
Example URI
GET /propdev/api/v1/s2s-errors/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
}Get All S2s ErrorsGET/propdev/api/v1/s2s-errors/
Example URI
GET /propdev/api/v1/s2s-errors/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s Errors with FilteringGET/propdev/api/v1/s2s-errors/
Example URI
GET /propdev/api/v1/s2s-errors/
URI Parameters
- id
string(optional)S2s Error Id. Maximum length is 12.
- key
string(optional)Key. Maximum length is 200.
- message
string(optional)Message. Maximum length is 200.
- link
string(optional)Link. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s ErrorsGET/propdev/api/v1/s2s-errors/
Example URI
GET /propdev/api/v1/s2s-errors/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"key",
"message",
"link"
],
"primaryKey": "id"
}Get Blueprint API specification for S2s ErrorsGET/propdev/api/v1/s2s-errors/
Example URI
GET /propdev/api/v1/s2s-errors/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s Errors.md"
transfer-encoding: chunkedUpdate S2s ErrorsPUT/propdev/api/v1/s2s-errors/(key)
Example URI
PUT /propdev/api/v1/s2s-errors/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s ErrorsPUT/propdev/api/v1/s2s-errors/
Example URI
PUT /propdev/api/v1/s2s-errors/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s ErrorsPATCH/propdev/api/v1/s2s-errors/(key)
Example URI
PATCH /propdev/api/v1/s2s-errors/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
}Insert S2s ErrorsPOST/propdev/api/v1/s2s-errors/
Example URI
POST /propdev/api/v1/s2s-errors/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s ErrorsPOST/propdev/api/v1/s2s-errors/
Example URI
POST /propdev/api/v1/s2s-errors/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"key": "(val)",
"message": "(val)",
"link": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s Errors by KeyDELETE/propdev/api/v1/s2s-errors/(key)
Example URI
DELETE /propdev/api/v1/s2s-errors/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s ErrorsDELETE/propdev/api/v1/s2s-errors/
Example URI
DELETE /propdev/api/v1/s2s-errors/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Errors with MatchingDELETE/propdev/api/v1/s2s-errors/
Example URI
DELETE /propdev/api/v1/s2s-errors/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)S2s Error Id. Maximum length is 12.
- key
string(optional)Key. Maximum length is 200.
- message
string(optional)Message. Maximum length is 200.
- link
string(optional)Link. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s Opportunities ¶
Get S2s Opportunities by KeyGET/propdev/api/v1/s2s-opportunities/(key)
Example URI
GET /propdev/api/v1/s2s-opportunities/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
}Get All S2s OpportunitiesGET/propdev/api/v1/s2s-opportunities/
Example URI
GET /propdev/api/v1/s2s-opportunities/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
},
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s Opportunities with FilteringGET/propdev/api/v1/s2s-opportunities/
Example URI
GET /propdev/api/v1/s2s-opportunities/
URI Parameters
- cfdaNumber
string(optional)A unique identifier for the sponsor and the funding opportunity announcement. AKA “Catalogue of Federal Domestic Assistance Number”. Maximum length is 6.
- closingDate
string(optional)Closing Date. Maximum length is 21.
- competitionId
string(optional)Competition Id. Maximum length is 50.
- instructionUrl
string(optional)Instruction Page. Maximum length is 300.
- openingDate
string(optional)Opening Date. Maximum length is 21.
- opportunity
string(optional)Opportunity. Maximum length is 40000000.
- opportunityId
string(optional)A unique identifier associated with each sponsor’s funding opportunity announcement. AKA “Funding Opportunity Announcement number” or “FOA number”. Maximum length is 50.
- opportunityTitle
string(optional)The title of a publicly available document, announcing a federal agency’s intentions to award discretionary grants or cooperative agreements, usually as a result of competition for funds. AKA Funding opportunity announcements, notices of funding availability, or solicitations. Maximum length is 255.
- revisionCode
string(optional)S2s Revision Type Code. Maximum length is 3.
- revisionOtherDescription
string(optional)Revision Other Description. Maximum length is 45.
- s2sSubmissionTypeCode
string(optional)Submission Type. Maximum length is 3.
- schemaUrl
string(optional)Schema URL. Maximum length is 300.
- offeringAgency
string(optional)Offering Agency.
- agencyContactInfo
string(optional)Agency Contact Info.
- cfdaDescription
string(optional)Cfda Description.
- multiProject
string(optional)Is this a multiple project opportunity?. Maximum length is 1.
- providerCode
string(optional)S2S Provider. Maximum length is 4.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
},
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s OpportunitiesGET/propdev/api/v1/s2s-opportunities/
Example URI
GET /propdev/api/v1/s2s-opportunities/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"cfdaNumber",
"closingDate",
"competitionId",
"instructionUrl",
"openingDate",
"opportunity",
"opportunityId",
"opportunityTitle",
"revisionCode",
"revisionOtherDescription",
"s2sSubmissionTypeCode",
"schemaUrl",
"offeringAgency",
"agencyContactInfo",
"cfdaDescription",
"multiProject",
"providerCode"
],
"primaryKey": "developmentProposal"
}Get Blueprint API specification for S2s OpportunitiesGET/propdev/api/v1/s2s-opportunities/
Example URI
GET /propdev/api/v1/s2s-opportunities/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s Opportunities.md"
transfer-encoding: chunkedUpdate S2s OpportunitiesPUT/propdev/api/v1/s2s-opportunities/(key)
Example URI
PUT /propdev/api/v1/s2s-opportunities/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s OpportunitiesPUT/propdev/api/v1/s2s-opportunities/
Example URI
PUT /propdev/api/v1/s2s-opportunities/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
},
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s OpportunitiesPATCH/propdev/api/v1/s2s-opportunities/(key)
Example URI
PATCH /propdev/api/v1/s2s-opportunities/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
}Insert S2s OpportunitiesPOST/propdev/api/v1/s2s-opportunities/
Example URI
POST /propdev/api/v1/s2s-opportunities/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s OpportunitiesPOST/propdev/api/v1/s2s-opportunities/
Example URI
POST /propdev/api/v1/s2s-opportunities/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
},
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
},
{
"cfdaNumber": "(val)",
"closingDate": "(val)",
"competitionId": "(val)",
"instructionUrl": "(val)",
"openingDate": "(val)",
"opportunity": "(val)",
"opportunityId": "(val)",
"opportunityTitle": "(val)",
"revisionCode": "(val)",
"revisionOtherDescription": "(val)",
"s2sSubmissionTypeCode": "(val)",
"schemaUrl": "(val)",
"offeringAgency": "(val)",
"agencyContactInfo": "(val)",
"cfdaDescription": "(val)",
"multiProject": "(val)",
"providerCode": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s Opportunities by KeyDELETE/propdev/api/v1/s2s-opportunities/(key)
Example URI
DELETE /propdev/api/v1/s2s-opportunities/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s OpportunitiesDELETE/propdev/api/v1/s2s-opportunities/
Example URI
DELETE /propdev/api/v1/s2s-opportunities/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Opportunities with MatchingDELETE/propdev/api/v1/s2s-opportunities/
Example URI
DELETE /propdev/api/v1/s2s-opportunities/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- cfdaNumber
string(optional)A unique identifier for the sponsor and the funding opportunity announcement. AKA “Catalogue of Federal Domestic Assistance Number”. Maximum length is 6.
- closingDate
string(optional)Closing Date. Maximum length is 21.
- competitionId
string(optional)Competition Id. Maximum length is 50.
- instructionUrl
string(optional)Instruction Page. Maximum length is 300.
- openingDate
string(optional)Opening Date. Maximum length is 21.
- opportunity
string(optional)Opportunity. Maximum length is 40000000.
- opportunityId
string(optional)A unique identifier associated with each sponsor’s funding opportunity announcement. AKA “Funding Opportunity Announcement number” or “FOA number”. Maximum length is 50.
- opportunityTitle
string(optional)The title of a publicly available document, announcing a federal agency’s intentions to award discretionary grants or cooperative agreements, usually as a result of competition for funds. AKA Funding opportunity announcements, notices of funding availability, or solicitations. Maximum length is 255.
- revisionCode
string(optional)S2s Revision Type Code. Maximum length is 3.
- revisionOtherDescription
string(optional)Revision Other Description. Maximum length is 45.
- s2sSubmissionTypeCode
string(optional)Submission Type. Maximum length is 3.
- schemaUrl
string(optional)Schema URL. Maximum length is 300.
- offeringAgency
string(optional)Offering Agency.
- agencyContactInfo
string(optional)Agency Contact Info.
- cfdaDescription
string(optional)Cfda Description.
- multiProject
string(optional)Is this a multiple project opportunity?. Maximum length is 1.
- providerCode
string(optional)S2S Provider. Maximum length is 4.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s Opportunity Form Questionnaires ¶
Get S2s Opportunity Form Questionnaires by KeyGET/propdev/api/v1/s2s-opportunity-form-questionnaires/(key)
Example URI
GET /propdev/api/v1/s2s-opportunity-form-questionnaires/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
}Get All S2s Opportunity Form QuestionnairesGET/propdev/api/v1/s2s-opportunity-form-questionnaires/
Example URI
GET /propdev/api/v1/s2s-opportunity-form-questionnaires/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
},
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s Opportunity Form Questionnaires with FilteringGET/propdev/api/v1/s2s-opportunity-form-questionnaires/
Example URI
GET /propdev/api/v1/s2s-opportunity-form-questionnaires/
URI Parameters
- s2sOppFormQuestionnaireId
string(optional)S2S Opportunity Form to Questionnaire Mapping Id. Maximum length is 12.
- oppNameSpace
string(optional)Namespace. Maximum length is 200.
- formName
string(optional)Form Name. Maximum length is 100.
- questionnaireId
string(optional)Questionnaire Ref Id. Maximum length is 10.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
},
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s Opportunity Form QuestionnairesGET/propdev/api/v1/s2s-opportunity-form-questionnaires/
Example URI
GET /propdev/api/v1/s2s-opportunity-form-questionnaires/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"s2sOppFormQuestionnaireId",
"oppNameSpace",
"formName",
"questionnaireId"
],
"primaryKey": "s2sOppFormQuestionnaireId"
}Get Blueprint API specification for S2s Opportunity Form QuestionnairesGET/propdev/api/v1/s2s-opportunity-form-questionnaires/
Example URI
GET /propdev/api/v1/s2s-opportunity-form-questionnaires/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s Opportunity Form Questionnaires.md"
transfer-encoding: chunkedUpdate S2s Opportunity Form QuestionnairesPUT/propdev/api/v1/s2s-opportunity-form-questionnaires/(key)
Example URI
PUT /propdev/api/v1/s2s-opportunity-form-questionnaires/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s Opportunity Form QuestionnairesPUT/propdev/api/v1/s2s-opportunity-form-questionnaires/
Example URI
PUT /propdev/api/v1/s2s-opportunity-form-questionnaires/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
},
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s Opportunity Form QuestionnairesPATCH/propdev/api/v1/s2s-opportunity-form-questionnaires/(key)
Example URI
PATCH /propdev/api/v1/s2s-opportunity-form-questionnaires/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
}Insert S2s Opportunity Form QuestionnairesPOST/propdev/api/v1/s2s-opportunity-form-questionnaires/
Example URI
POST /propdev/api/v1/s2s-opportunity-form-questionnaires/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s Opportunity Form QuestionnairesPOST/propdev/api/v1/s2s-opportunity-form-questionnaires/
Example URI
POST /propdev/api/v1/s2s-opportunity-form-questionnaires/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
},
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
},
{
"s2sOppFormQuestionnaireId": "(val)",
"oppNameSpace": "(val)",
"formName": "(val)",
"questionnaireId": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s Opportunity Form Questionnaires by KeyDELETE/propdev/api/v1/s2s-opportunity-form-questionnaires/(key)
Example URI
DELETE /propdev/api/v1/s2s-opportunity-form-questionnaires/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Opportunity Form QuestionnairesDELETE/propdev/api/v1/s2s-opportunity-form-questionnaires/
Example URI
DELETE /propdev/api/v1/s2s-opportunity-form-questionnaires/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Opportunity Form Questionnaires with MatchingDELETE/propdev/api/v1/s2s-opportunity-form-questionnaires/
Example URI
DELETE /propdev/api/v1/s2s-opportunity-form-questionnaires/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- s2sOppFormQuestionnaireId
string(optional)S2S Opportunity Form to Questionnaire Mapping Id. Maximum length is 12.
- oppNameSpace
string(optional)Namespace. Maximum length is 200.
- formName
string(optional)Form Name. Maximum length is 100.
- questionnaireId
string(optional)Questionnaire Ref Id. Maximum length is 10.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s Opportunity Forms ¶
Get S2s Opportunity Forms by KeyGET/propdev/api/v1/s2s-opportunity-forms/(key)
Example URI
GET /propdev/api/v1/s2s-opportunity-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
}Get All S2s Opportunity FormsGET/propdev/api/v1/s2s-opportunity-forms/
Example URI
GET /propdev/api/v1/s2s-opportunity-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
},
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s Opportunity Forms with FilteringGET/propdev/api/v1/s2s-opportunity-forms/
Example URI
GET /propdev/api/v1/s2s-opportunity-forms/
URI Parameters
- s2sOppFormsId
string(optional)S 2s Opp Forms Id.
- available
string(optional)Available. Maximum length is 1.
- formName
string(optional)Form Name. Maximum length is 100.
- include
string(optional)Include. Maximum length is 1.
- mandatory
string(optional)Mandatory. Maximum length is 1.
- userAttachedForm
string(optional)User Attached Form.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
},
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s Opportunity FormsGET/propdev/api/v1/s2s-opportunity-forms/
Example URI
GET /propdev/api/v1/s2s-opportunity-forms/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"s2sOppFormsId",
"available",
"formName",
"include",
"mandatory",
"userAttachedForm"
],
"primaryKey": "oppNameSpace:proposalNumber"
}Get Blueprint API specification for S2s Opportunity FormsGET/propdev/api/v1/s2s-opportunity-forms/
Example URI
GET /propdev/api/v1/s2s-opportunity-forms/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s Opportunity Forms.md"
transfer-encoding: chunkedUpdate S2s Opportunity FormsPUT/propdev/api/v1/s2s-opportunity-forms/(key)
Example URI
PUT /propdev/api/v1/s2s-opportunity-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s Opportunity FormsPUT/propdev/api/v1/s2s-opportunity-forms/
Example URI
PUT /propdev/api/v1/s2s-opportunity-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
},
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s Opportunity FormsPATCH/propdev/api/v1/s2s-opportunity-forms/(key)
Example URI
PATCH /propdev/api/v1/s2s-opportunity-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
}Insert S2s Opportunity FormsPOST/propdev/api/v1/s2s-opportunity-forms/
Example URI
POST /propdev/api/v1/s2s-opportunity-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s Opportunity FormsPOST/propdev/api/v1/s2s-opportunity-forms/
Example URI
POST /propdev/api/v1/s2s-opportunity-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
},
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
},
{
"s2sOppFormsId": "(val)",
"available": "(val)",
"formName": "(val)",
"include": "(val)",
"mandatory": "(val)",
"userAttachedForm": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s Opportunity Forms by KeyDELETE/propdev/api/v1/s2s-opportunity-forms/(key)
Example URI
DELETE /propdev/api/v1/s2s-opportunity-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Opportunity FormsDELETE/propdev/api/v1/s2s-opportunity-forms/
Example URI
DELETE /propdev/api/v1/s2s-opportunity-forms/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Opportunity Forms with MatchingDELETE/propdev/api/v1/s2s-opportunity-forms/
Example URI
DELETE /propdev/api/v1/s2s-opportunity-forms/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- s2sOppFormsId
string(optional)S 2s Opp Forms Id.
- available
string(optional)Available. Maximum length is 1.
- formName
string(optional)Form Name. Maximum length is 100.
- include
string(optional)Include. Maximum length is 1.
- mandatory
string(optional)Mandatory. Maximum length is 1.
- userAttachedForm
string(optional)User Attached Form.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s Providers ¶
Get S2s Providers by KeyGET/propdev/api/v1/s2s-providers/(key)
Example URI
GET /propdev/api/v1/s2s-providers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All S2s ProvidersGET/propdev/api/v1/s2s-providers/
Example URI
GET /propdev/api/v1/s2s-providers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s Providers with FilteringGET/propdev/api/v1/s2s-providers/
Example URI
GET /propdev/api/v1/s2s-providers/
URI Parameters
- code
string(optional)S2S Provider Code. Maximum length is 4.
- description
string(optional)Description. Maximum length is 4000.
- connectorServiceName
string(optional)S2S Connector Spring Service Name. Maximum length is 1000.
- active
string(optional)This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s ProvidersGET/propdev/api/v1/s2s-providers/
Example URI
GET /propdev/api/v1/s2s-providers/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description",
"connectorServiceName",
"active"
],
"primaryKey": "code"
}Get Blueprint API specification for S2s ProvidersGET/propdev/api/v1/s2s-providers/
Example URI
GET /propdev/api/v1/s2s-providers/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s Providers.md"
transfer-encoding: chunkedUpdate S2s ProvidersPUT/propdev/api/v1/s2s-providers/(key)
Example URI
PUT /propdev/api/v1/s2s-providers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s ProvidersPUT/propdev/api/v1/s2s-providers/
Example URI
PUT /propdev/api/v1/s2s-providers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s ProvidersPATCH/propdev/api/v1/s2s-providers/(key)
Example URI
PATCH /propdev/api/v1/s2s-providers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert S2s ProvidersPOST/propdev/api/v1/s2s-providers/
Example URI
POST /propdev/api/v1/s2s-providers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s ProvidersPOST/propdev/api/v1/s2s-providers/
Example URI
POST /propdev/api/v1/s2s-providers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"connectorServiceName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s Providers by KeyDELETE/propdev/api/v1/s2s-providers/(key)
Example URI
DELETE /propdev/api/v1/s2s-providers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s ProvidersDELETE/propdev/api/v1/s2s-providers/
Example URI
DELETE /propdev/api/v1/s2s-providers/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Providers with MatchingDELETE/propdev/api/v1/s2s-providers/
Example URI
DELETE /propdev/api/v1/s2s-providers/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)S2S Provider Code. Maximum length is 4.
- description
string(optional)Description. Maximum length is 4000.
- connectorServiceName
string(optional)S2S Connector Spring Service Name. Maximum length is 1000.
- active
string(optional)This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s Revision Types ¶
Get S2s Revision Types by KeyGET/propdev/api/v1/s2s-revision-types/(key)
Example URI
GET /propdev/api/v1/s2s-revision-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All S2s Revision TypesGET/propdev/api/v1/s2s-revision-types/
Example URI
GET /propdev/api/v1/s2s-revision-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s Revision Types with FilteringGET/propdev/api/v1/s2s-revision-types/
Example URI
GET /propdev/api/v1/s2s-revision-types/
URI Parameters
- code
string(optional)S2s Revision Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s Revision TypesGET/propdev/api/v1/s2s-revision-types/
Example URI
GET /propdev/api/v1/s2s-revision-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for S2s Revision TypesGET/propdev/api/v1/s2s-revision-types/
Example URI
GET /propdev/api/v1/s2s-revision-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s Revision Types.md"
transfer-encoding: chunkedUpdate S2s Revision TypesPUT/propdev/api/v1/s2s-revision-types/(key)
Example URI
PUT /propdev/api/v1/s2s-revision-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s Revision TypesPUT/propdev/api/v1/s2s-revision-types/
Example URI
PUT /propdev/api/v1/s2s-revision-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s Revision TypesPATCH/propdev/api/v1/s2s-revision-types/(key)
Example URI
PATCH /propdev/api/v1/s2s-revision-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert S2s Revision TypesPOST/propdev/api/v1/s2s-revision-types/
Example URI
POST /propdev/api/v1/s2s-revision-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s Revision TypesPOST/propdev/api/v1/s2s-revision-types/
Example URI
POST /propdev/api/v1/s2s-revision-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s Revision Types by KeyDELETE/propdev/api/v1/s2s-revision-types/(key)
Example URI
DELETE /propdev/api/v1/s2s-revision-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Revision TypesDELETE/propdev/api/v1/s2s-revision-types/
Example URI
DELETE /propdev/api/v1/s2s-revision-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Revision Types with MatchingDELETE/propdev/api/v1/s2s-revision-types/
Example URI
DELETE /propdev/api/v1/s2s-revision-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)S2s Revision Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s Submission Types ¶
Get S2s Submission Types by KeyGET/propdev/api/v1/s2s-submission-types/(key)
Example URI
GET /propdev/api/v1/s2s-submission-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Get All S2s Submission TypesGET/propdev/api/v1/s2s-submission-types/
Example URI
GET /propdev/api/v1/s2s-submission-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s Submission Types with FilteringGET/propdev/api/v1/s2s-submission-types/
Example URI
GET /propdev/api/v1/s2s-submission-types/
URI Parameters
- code
string(optional)Submission Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- sortId
string(optional)Sort Id.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s Submission TypesGET/propdev/api/v1/s2s-submission-types/
Example URI
GET /propdev/api/v1/s2s-submission-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description",
"sortId"
],
"primaryKey": "code"
}Get Blueprint API specification for S2s Submission TypesGET/propdev/api/v1/s2s-submission-types/
Example URI
GET /propdev/api/v1/s2s-submission-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s Submission Types.md"
transfer-encoding: chunkedUpdate S2s Submission TypesPUT/propdev/api/v1/s2s-submission-types/(key)
Example URI
PUT /propdev/api/v1/s2s-submission-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s Submission TypesPUT/propdev/api/v1/s2s-submission-types/
Example URI
PUT /propdev/api/v1/s2s-submission-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s Submission TypesPATCH/propdev/api/v1/s2s-submission-types/(key)
Example URI
PATCH /propdev/api/v1/s2s-submission-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Insert S2s Submission TypesPOST/propdev/api/v1/s2s-submission-types/
Example URI
POST /propdev/api/v1/s2s-submission-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s Submission TypesPOST/propdev/api/v1/s2s-submission-types/
Example URI
POST /propdev/api/v1/s2s-submission-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s Submission Types by KeyDELETE/propdev/api/v1/s2s-submission-types/(key)
Example URI
DELETE /propdev/api/v1/s2s-submission-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Submission TypesDELETE/propdev/api/v1/s2s-submission-types/
Example URI
DELETE /propdev/api/v1/s2s-submission-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s Submission Types with MatchingDELETE/propdev/api/v1/s2s-submission-types/
Example URI
DELETE /propdev/api/v1/s2s-submission-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Submission Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- sortId
string(optional)Sort Id.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s User Attached Form Attachment Files ¶
Get S2s User Attached Form Attachment Files by KeyGET/propdev/api/v1/s2s-user-attached-form-attachment-files/(key)
Example URI
GET /propdev/api/v1/s2s-user-attached-form-attachment-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
}Get All S2s User Attached Form Attachment FilesGET/propdev/api/v1/s2s-user-attached-form-attachment-files/
Example URI
GET /propdev/api/v1/s2s-user-attached-form-attachment-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s User Attached Form Attachment Files with FilteringGET/propdev/api/v1/s2s-user-attached-form-attachment-files/
Example URI
GET /propdev/api/v1/s2s-user-attached-form-attachment-files/
URI Parameters
- id
string(optional)- attachment
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s User Attached Form Attachment FilesGET/propdev/api/v1/s2s-user-attached-form-attachment-files/
Example URI
GET /propdev/api/v1/s2s-user-attached-form-attachment-files/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"attachment"
],
"primaryKey": "id"
}Get Blueprint API specification for S2s User Attached Form Attachment FilesGET/propdev/api/v1/s2s-user-attached-form-attachment-files/
Example URI
GET /propdev/api/v1/s2s-user-attached-form-attachment-files/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s User Attached Form Attachment Files.md"
transfer-encoding: chunkedUpdate S2s User Attached Form Attachment FilesPUT/propdev/api/v1/s2s-user-attached-form-attachment-files/(key)
Example URI
PUT /propdev/api/v1/s2s-user-attached-form-attachment-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s User Attached Form Attachment FilesPUT/propdev/api/v1/s2s-user-attached-form-attachment-files/
Example URI
PUT /propdev/api/v1/s2s-user-attached-form-attachment-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s User Attached Form Attachment FilesPATCH/propdev/api/v1/s2s-user-attached-form-attachment-files/(key)
Example URI
PATCH /propdev/api/v1/s2s-user-attached-form-attachment-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
}Insert S2s User Attached Form Attachment FilesPOST/propdev/api/v1/s2s-user-attached-form-attachment-files/
Example URI
POST /propdev/api/v1/s2s-user-attached-form-attachment-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s User Attached Form Attachment FilesPOST/propdev/api/v1/s2s-user-attached-form-attachment-files/
Example URI
POST /propdev/api/v1/s2s-user-attached-form-attachment-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"attachment": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s User Attached Form Attachment Files by KeyDELETE/propdev/api/v1/s2s-user-attached-form-attachment-files/(key)
Example URI
DELETE /propdev/api/v1/s2s-user-attached-form-attachment-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s User Attached Form Attachment FilesDELETE/propdev/api/v1/s2s-user-attached-form-attachment-files/
Example URI
DELETE /propdev/api/v1/s2s-user-attached-form-attachment-files/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s User Attached Form Attachment Files with MatchingDELETE/propdev/api/v1/s2s-user-attached-form-attachment-files/
Example URI
DELETE /propdev/api/v1/s2s-user-attached-form-attachment-files/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)- attachment
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s User Attached Form Attachments ¶
Get S2s User Attached Form Attachments by KeyGET/propdev/api/v1/s2s-user-attached-form-attachments/(key)
Example URI
GET /propdev/api/v1/s2s-user-attached-form-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
}Get All S2s User Attached Form AttachmentsGET/propdev/api/v1/s2s-user-attached-form-attachments/
Example URI
GET /propdev/api/v1/s2s-user-attached-form-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s User Attached Form Attachments with FilteringGET/propdev/api/v1/s2s-user-attached-form-attachments/
Example URI
GET /propdev/api/v1/s2s-user-attached-form-attachments/
URI Parameters
- id
string(optional)- proposalNumber
string(optional)- type
string(optional)- name
string(optional)- contentId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s User Attached Form AttachmentsGET/propdev/api/v1/s2s-user-attached-form-attachments/
Example URI
GET /propdev/api/v1/s2s-user-attached-form-attachments/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"proposalNumber",
"type",
"name",
"contentId"
],
"primaryKey": "id"
}Get Blueprint API specification for S2s User Attached Form AttachmentsGET/propdev/api/v1/s2s-user-attached-form-attachments/
Example URI
GET /propdev/api/v1/s2s-user-attached-form-attachments/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s User Attached Form Attachments.md"
transfer-encoding: chunkedUpdate S2s User Attached Form AttachmentsPUT/propdev/api/v1/s2s-user-attached-form-attachments/(key)
Example URI
PUT /propdev/api/v1/s2s-user-attached-form-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s User Attached Form AttachmentsPUT/propdev/api/v1/s2s-user-attached-form-attachments/
Example URI
PUT /propdev/api/v1/s2s-user-attached-form-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s User Attached Form AttachmentsPATCH/propdev/api/v1/s2s-user-attached-form-attachments/(key)
Example URI
PATCH /propdev/api/v1/s2s-user-attached-form-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
}Insert S2s User Attached Form AttachmentsPOST/propdev/api/v1/s2s-user-attached-form-attachments/
Example URI
POST /propdev/api/v1/s2s-user-attached-form-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s User Attached Form AttachmentsPOST/propdev/api/v1/s2s-user-attached-form-attachments/
Example URI
POST /propdev/api/v1/s2s-user-attached-form-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"proposalNumber": "(val)",
"type": "(val)",
"name": "(val)",
"contentId": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s User Attached Form Attachments by KeyDELETE/propdev/api/v1/s2s-user-attached-form-attachments/(key)
Example URI
DELETE /propdev/api/v1/s2s-user-attached-form-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s User Attached Form AttachmentsDELETE/propdev/api/v1/s2s-user-attached-form-attachments/
Example URI
DELETE /propdev/api/v1/s2s-user-attached-form-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s User Attached Form Attachments with MatchingDELETE/propdev/api/v1/s2s-user-attached-form-attachments/
Example URI
DELETE /propdev/api/v1/s2s-user-attached-form-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)- proposalNumber
string(optional)- type
string(optional)- name
string(optional)- contentId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s User Attached Form Files ¶
Get S2s User Attached Form Files by KeyGET/propdev/api/v1/s2s-user-attached-form-files/(key)
Example URI
GET /propdev/api/v1/s2s-user-attached-form-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
}Get All S2s User Attached Form FilesGET/propdev/api/v1/s2s-user-attached-form-files/
Example URI
GET /propdev/api/v1/s2s-user-attached-form-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s User Attached Form Files with FilteringGET/propdev/api/v1/s2s-user-attached-form-files/
Example URI
GET /propdev/api/v1/s2s-user-attached-form-files/
URI Parameters
- id
string(optional)- formFile
string(optional)- xmlFile
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s User Attached Form FilesGET/propdev/api/v1/s2s-user-attached-form-files/
Example URI
GET /propdev/api/v1/s2s-user-attached-form-files/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"formFile",
"xmlFile"
],
"primaryKey": "id"
}Get Blueprint API specification for S2s User Attached Form FilesGET/propdev/api/v1/s2s-user-attached-form-files/
Example URI
GET /propdev/api/v1/s2s-user-attached-form-files/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s User Attached Form Files.md"
transfer-encoding: chunkedUpdate S2s User Attached Form FilesPUT/propdev/api/v1/s2s-user-attached-form-files/(key)
Example URI
PUT /propdev/api/v1/s2s-user-attached-form-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s User Attached Form FilesPUT/propdev/api/v1/s2s-user-attached-form-files/
Example URI
PUT /propdev/api/v1/s2s-user-attached-form-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s User Attached Form FilesPATCH/propdev/api/v1/s2s-user-attached-form-files/(key)
Example URI
PATCH /propdev/api/v1/s2s-user-attached-form-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
}Insert S2s User Attached Form FilesPOST/propdev/api/v1/s2s-user-attached-form-files/
Example URI
POST /propdev/api/v1/s2s-user-attached-form-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s User Attached Form FilesPOST/propdev/api/v1/s2s-user-attached-form-files/
Example URI
POST /propdev/api/v1/s2s-user-attached-form-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"formFile": "(val)",
"xmlFile": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s User Attached Form Files by KeyDELETE/propdev/api/v1/s2s-user-attached-form-files/(key)
Example URI
DELETE /propdev/api/v1/s2s-user-attached-form-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s User Attached Form FilesDELETE/propdev/api/v1/s2s-user-attached-form-files/
Example URI
DELETE /propdev/api/v1/s2s-user-attached-form-files/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s User Attached Form Files with MatchingDELETE/propdev/api/v1/s2s-user-attached-form-files/
Example URI
DELETE /propdev/api/v1/s2s-user-attached-form-files/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)- formFile
string(optional)- xmlFile
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204S2s User Attached Forms ¶
Get S2s User Attached Forms by KeyGET/propdev/api/v1/s2s-user-attached-forms/(key)
Example URI
GET /propdev/api/v1/s2s-user-attached-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All S2s User Attached FormsGET/propdev/api/v1/s2s-user-attached-forms/
Example URI
GET /propdev/api/v1/s2s-user-attached-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All S2s User Attached Forms with FilteringGET/propdev/api/v1/s2s-user-attached-forms/
Example URI
GET /propdev/api/v1/s2s-user-attached-forms/
URI Parameters
- id
string(optional)- proposalNumber
string(optional)- namespace
string(optional)- formName
string(optional)- formFileName
string(optional)- description
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for S2s User Attached FormsGET/propdev/api/v1/s2s-user-attached-forms/
Example URI
GET /propdev/api/v1/s2s-user-attached-forms/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"proposalNumber",
"namespace",
"formName",
"formFileName",
"description"
],
"primaryKey": "id"
}Get Blueprint API specification for S2s User Attached FormsGET/propdev/api/v1/s2s-user-attached-forms/
Example URI
GET /propdev/api/v1/s2s-user-attached-forms/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="S2s User Attached Forms.md"
transfer-encoding: chunkedUpdate S2s User Attached FormsPUT/propdev/api/v1/s2s-user-attached-forms/(key)
Example URI
PUT /propdev/api/v1/s2s-user-attached-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple S2s User Attached FormsPUT/propdev/api/v1/s2s-user-attached-forms/
Example URI
PUT /propdev/api/v1/s2s-user-attached-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes S2s User Attached FormsPATCH/propdev/api/v1/s2s-user-attached-forms/(key)
Example URI
PATCH /propdev/api/v1/s2s-user-attached-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert S2s User Attached FormsPOST/propdev/api/v1/s2s-user-attached-forms/
Example URI
POST /propdev/api/v1/s2s-user-attached-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple S2s User Attached FormsPOST/propdev/api/v1/s2s-user-attached-forms/
Example URI
POST /propdev/api/v1/s2s-user-attached-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"proposalNumber": "(val)",
"namespace": "(val)",
"formName": "(val)",
"formFileName": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete S2s User Attached Forms by KeyDELETE/propdev/api/v1/s2s-user-attached-forms/(key)
Example URI
DELETE /propdev/api/v1/s2s-user-attached-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s User Attached FormsDELETE/propdev/api/v1/s2s-user-attached-forms/
Example URI
DELETE /propdev/api/v1/s2s-user-attached-forms/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All S2s User Attached Forms with MatchingDELETE/propdev/api/v1/s2s-user-attached-forms/
Example URI
DELETE /propdev/api/v1/s2s-user-attached-forms/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)- proposalNumber
string(optional)- namespace
string(optional)- formName
string(optional)- formFileName
string(optional)- description
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Valid Narrative Forms ¶
Get Valid Narrative Forms by KeyGET/propdev/api/v1/valid-narrative-forms/(key)
Example URI
GET /propdev/api/v1/valid-narrative-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}Get All Valid Narrative FormsGET/propdev/api/v1/valid-narrative-forms/
Example URI
GET /propdev/api/v1/valid-narrative-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
},
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}
]Get All Valid Narrative Forms with FilteringGET/propdev/api/v1/valid-narrative-forms/
Example URI
GET /propdev/api/v1/valid-narrative-forms/
URI Parameters
- validNarrFormsId
string(optional)Valid Narr Forms Id. Maximum length is 22.
- formName
string(optional)Form Name. Maximum length is 100.
- narrativeTypeCode
string(optional)Narrative Type Code. Maximum length is 22.
- mandatory
string(optional)Mandatory. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
},
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Valid Narrative FormsGET/propdev/api/v1/valid-narrative-forms/
Example URI
GET /propdev/api/v1/valid-narrative-forms/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"validNarrFormsId",
"formName",
"narrativeTypeCode",
"mandatory"
],
"primaryKey": "validNarrFormsId"
}Get Blueprint API specification for Valid Narrative FormsGET/propdev/api/v1/valid-narrative-forms/
Example URI
GET /propdev/api/v1/valid-narrative-forms/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Narrative Forms.md"
transfer-encoding: chunkedUpdate Valid Narrative FormsPUT/propdev/api/v1/valid-narrative-forms/(key)
Example URI
PUT /propdev/api/v1/valid-narrative-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Valid Narrative FormsPUT/propdev/api/v1/valid-narrative-forms/
Example URI
PUT /propdev/api/v1/valid-narrative-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
},
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Valid Narrative FormsPATCH/propdev/api/v1/valid-narrative-forms/(key)
Example URI
PATCH /propdev/api/v1/valid-narrative-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}Insert Valid Narrative FormsPOST/propdev/api/v1/valid-narrative-forms/
Example URI
POST /propdev/api/v1/valid-narrative-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Valid Narrative FormsPOST/propdev/api/v1/valid-narrative-forms/
Example URI
POST /propdev/api/v1/valid-narrative-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
},
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
},
{
"validNarrFormsId": "(val)",
"formName": "(val)",
"narrativeTypeCode": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}
]Delete Valid Narrative Forms by KeyDELETE/propdev/api/v1/valid-narrative-forms/(key)
Example URI
DELETE /propdev/api/v1/valid-narrative-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Narrative FormsDELETE/propdev/api/v1/valid-narrative-forms/
Example URI
DELETE /propdev/api/v1/valid-narrative-forms/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Narrative Forms with MatchingDELETE/propdev/api/v1/valid-narrative-forms/
Example URI
DELETE /propdev/api/v1/valid-narrative-forms/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- validNarrFormsId
string(optional)Valid Narr Forms Id. Maximum length is 22.
- formName
string(optional)Form Name. Maximum length is 100.
- narrativeTypeCode
string(optional)Narrative Type Code. Maximum length is 22.
- mandatory
string(optional)Mandatory. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204