Back to top

API Documentation

< Back

Kuali Research REST APIs - Institutional Proposal

Research Institutional Proposal

Indirectcost Rate Types

Get Indirectcost Rate Types by Key
GET/instprop/api/v1/indirectcost-rate-types/(key)

Example URI

GET /instprop/api/v1/indirectcost-rate-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "indirectcostRateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Indirectcost Rate Types
GET/instprop/api/v1/indirectcost-rate-types/

Example URI

GET /instprop/api/v1/indirectcost-rate-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "indirectcostRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "indirectcostRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Indirectcost Rate Types with Filtering
GET/instprop/api/v1/indirectcost-rate-types/

Example URI

GET /instprop/api/v1/indirectcost-rate-types/
URI Parameters
HideShow
indirectcostRateTypeCode
string (optional) 

Indirectcost Rate Type Code. Maximum length is 22. Validating pattern is ^[0-9]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "indirectcostRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "indirectcostRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Indirectcost Rate Types
GET/instprop/api/v1/indirectcost-rate-types/

Example URI

GET /instprop/api/v1/indirectcost-rate-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "indirectcostRateTypeCode",
    "description"
  ],
  "primaryKey": "indirectcostRateTypeCode"
}

Get Blueprint API specification for Indirectcost Rate Types
GET/instprop/api/v1/indirectcost-rate-types/

Example URI

GET /instprop/api/v1/indirectcost-rate-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Indirectcost Rate Types.md"
transfer-encoding: chunked

Update Indirectcost Rate Types
PUT/instprop/api/v1/indirectcost-rate-types/(key)

Example URI

PUT /instprop/api/v1/indirectcost-rate-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "indirectcostRateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Indirectcost Rate Types
PUT/instprop/api/v1/indirectcost-rate-types/

Example URI

PUT /instprop/api/v1/indirectcost-rate-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "indirectcostRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "indirectcostRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Indirectcost Rate Types
PATCH/instprop/api/v1/indirectcost-rate-types/(key)

Example URI

PATCH /instprop/api/v1/indirectcost-rate-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "indirectcostRateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "indirectcostRateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Indirectcost Rate Types
POST/instprop/api/v1/indirectcost-rate-types/

Example URI

POST /instprop/api/v1/indirectcost-rate-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "indirectcostRateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "indirectcostRateTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Indirectcost Rate Types
POST/instprop/api/v1/indirectcost-rate-types/

Example URI

POST /instprop/api/v1/indirectcost-rate-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "indirectcostRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "indirectcostRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "indirectcostRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "indirectcostRateTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Indirectcost Rate Types by Key
DELETE/instprop/api/v1/indirectcost-rate-types/(key)

Example URI

DELETE /instprop/api/v1/indirectcost-rate-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Indirectcost Rate Types
DELETE/instprop/api/v1/indirectcost-rate-types/

Example URI

DELETE /instprop/api/v1/indirectcost-rate-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Indirectcost Rate Types with Matching
DELETE/instprop/api/v1/indirectcost-rate-types/

Example URI

DELETE /instprop/api/v1/indirectcost-rate-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

indirectcostRateTypeCode
string (optional) 

Indirectcost Rate Type Code. Maximum length is 22. Validating pattern is ^[0-9]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Institutional Proposal Attachment Types

Get Institutional Proposal Attachment Types by Key
GET/instprop/api/v1/institutional-proposal-attachment-types/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-attachment-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "attachmentTypeCode": "(val)",
  "description": "(val)",
  "allowMultiple": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Attachment Types
GET/instprop/api/v1/institutional-proposal-attachment-types/

Example URI

GET /instprop/api/v1/institutional-proposal-attachment-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "attachmentTypeCode": "(val)",
    "description": "(val)",
    "allowMultiple": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "attachmentTypeCode": "(val)",
    "description": "(val)",
    "allowMultiple": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Attachment Types with Filtering
GET/instprop/api/v1/institutional-proposal-attachment-types/

Example URI

GET /instprop/api/v1/institutional-proposal-attachment-types/
URI Parameters
HideShow
attachmentTypeCode
string (optional) 

Code. Maximum length is 3. Validating pattern is ^[0-9]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[\u0000-\uFFFF]*$.

allowMultiple
string (optional) 

allowMultiple. Maximum length is 1. Validating pattern is ^[\p{Graph}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "attachmentTypeCode": "(val)",
    "description": "(val)",
    "allowMultiple": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "attachmentTypeCode": "(val)",
    "description": "(val)",
    "allowMultiple": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Attachment Types
GET/instprop/api/v1/institutional-proposal-attachment-types/

Example URI

GET /instprop/api/v1/institutional-proposal-attachment-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "attachmentTypeCode",
    "description",
    "allowMultiple"
  ],
  "primaryKey": "attachmentTypeCode"
}

Get Blueprint API specification for Institutional Proposal Attachment Types
GET/instprop/api/v1/institutional-proposal-attachment-types/

Example URI

GET /instprop/api/v1/institutional-proposal-attachment-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Attachment Types.md"
transfer-encoding: chunked

Update Institutional Proposal Attachment Types
PUT/instprop/api/v1/institutional-proposal-attachment-types/(key)

Example URI

PUT /instprop/api/v1/institutional-proposal-attachment-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "attachmentTypeCode": "(val)",
  "description": "(val)",
  "allowMultiple": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Institutional Proposal Attachment Types
PUT/instprop/api/v1/institutional-proposal-attachment-types/

Example URI

PUT /instprop/api/v1/institutional-proposal-attachment-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "attachmentTypeCode": "(val)",
    "description": "(val)",
    "allowMultiple": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "attachmentTypeCode": "(val)",
    "description": "(val)",
    "allowMultiple": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Institutional Proposal Attachment Types
PATCH/instprop/api/v1/institutional-proposal-attachment-types/(key)

Example URI

PATCH /instprop/api/v1/institutional-proposal-attachment-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "attachmentTypeCode": "(val)",
  "description": "(val)",
  "allowMultiple": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "attachmentTypeCode": "(val)",
  "description": "(val)",
  "allowMultiple": "(val)",
  "_primaryKey": "(val)"
}

Insert Institutional Proposal Attachment Types
POST/instprop/api/v1/institutional-proposal-attachment-types/

Example URI

POST /instprop/api/v1/institutional-proposal-attachment-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "attachmentTypeCode": "(val)",
  "description": "(val)",
  "allowMultiple": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "attachmentTypeCode": "(val)",
  "description": "(val)",
  "allowMultiple": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Institutional Proposal Attachment Types
POST/instprop/api/v1/institutional-proposal-attachment-types/

Example URI

POST /instprop/api/v1/institutional-proposal-attachment-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "attachmentTypeCode": "(val)",
    "description": "(val)",
    "allowMultiple": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "attachmentTypeCode": "(val)",
    "description": "(val)",
    "allowMultiple": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "attachmentTypeCode": "(val)",
    "description": "(val)",
    "allowMultiple": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "attachmentTypeCode": "(val)",
    "description": "(val)",
    "allowMultiple": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Institutional Proposal Attachment Types by Key
DELETE/instprop/api/v1/institutional-proposal-attachment-types/(key)

Example URI

DELETE /instprop/api/v1/institutional-proposal-attachment-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Attachment Types
DELETE/instprop/api/v1/institutional-proposal-attachment-types/

Example URI

DELETE /instprop/api/v1/institutional-proposal-attachment-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Attachment Types with Matching
DELETE/instprop/api/v1/institutional-proposal-attachment-types/

Example URI

DELETE /instprop/api/v1/institutional-proposal-attachment-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

attachmentTypeCode
string (optional) 

Code. Maximum length is 3. Validating pattern is ^[0-9]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[\u0000-\uFFFF]*$.

allowMultiple
string (optional) 

allowMultiple. Maximum length is 1. Validating pattern is ^[\p{Graph}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Institutional Proposal Attachments

Get Institutional Proposal Attachments by Key
GET/instprop/api/v1/institutional-proposal-attachments/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalAttachmentId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "fileDataId": "(val)",
  "sequenceNumber": "(val)",
  "attachmentNumber": "(val)",
  "attachmentTitle": "(val)",
  "attachmentTypeCode": "(val)",
  "fileName": "(val)",
  "contentType": "(val)",
  "comments": "(val)",
  "documentStatusCode": "(val)",
  "lastUpdateTimestamp": "(val)",
  "lastUpdateUser": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Attachments
GET/instprop/api/v1/institutional-proposal-attachments/

Example URI

GET /instprop/api/v1/institutional-proposal-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalAttachmentId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "fileDataId": "(val)",
    "sequenceNumber": "(val)",
    "attachmentNumber": "(val)",
    "attachmentTitle": "(val)",
    "attachmentTypeCode": "(val)",
    "fileName": "(val)",
    "contentType": "(val)",
    "comments": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalAttachmentId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "fileDataId": "(val)",
    "sequenceNumber": "(val)",
    "attachmentNumber": "(val)",
    "attachmentTitle": "(val)",
    "attachmentTypeCode": "(val)",
    "fileName": "(val)",
    "contentType": "(val)",
    "comments": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Attachments with Filtering
GET/instprop/api/v1/institutional-proposal-attachments/

Example URI

GET /instprop/api/v1/institutional-proposal-attachments/
URI Parameters
HideShow
proposalAttachmentId
string (optional) 
proposalId
string (optional) 
proposalNumber
string (optional) 
fileDataId
string (optional) 
sequenceNumber
string (optional) 
attachmentNumber
string (optional) 
attachmentTitle
string (optional) 

Description. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.

attachmentTypeCode
string (optional) 

Code. Maximum length is 3. Validating pattern is ^[0-9]*$.

fileName
string (optional) 

Id. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.

contentType
string (optional) 
comments
string (optional) 

Comments. Maximum length is 2000. Validating pattern is ^[\p{Graph}\p{Space}]*$.

documentStatusCode
string (optional) 
lastUpdateTimestamp
string (optional) 

The creation or last modification timestamp. Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

lastUpdateUser
string (optional) 

The user who created or last modified the object. Maximum length is 60. Validating pattern is ^[\p{Graph}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalAttachmentId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "fileDataId": "(val)",
    "sequenceNumber": "(val)",
    "attachmentNumber": "(val)",
    "attachmentTitle": "(val)",
    "attachmentTypeCode": "(val)",
    "fileName": "(val)",
    "contentType": "(val)",
    "comments": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalAttachmentId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "fileDataId": "(val)",
    "sequenceNumber": "(val)",
    "attachmentNumber": "(val)",
    "attachmentTitle": "(val)",
    "attachmentTypeCode": "(val)",
    "fileName": "(val)",
    "contentType": "(val)",
    "comments": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Attachments
GET/instprop/api/v1/institutional-proposal-attachments/

Example URI

GET /instprop/api/v1/institutional-proposal-attachments/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalAttachmentId",
    "proposalId",
    "proposalNumber",
    "fileDataId",
    "sequenceNumber",
    "attachmentNumber",
    "attachmentTitle",
    "attachmentTypeCode",
    "fileName",
    "contentType",
    "comments",
    "documentStatusCode",
    "lastUpdateTimestamp",
    "lastUpdateUser"
  ],
  "primaryKey": "proposalAttachmentId"
}

Get Blueprint API specification for Institutional Proposal Attachments
GET/instprop/api/v1/institutional-proposal-attachments/

Example URI

GET /instprop/api/v1/institutional-proposal-attachments/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Attachments.md"
transfer-encoding: chunked

Update Institutional Proposal Attachments
PUT/instprop/api/v1/institutional-proposal-attachments/(key)

Example URI

PUT /instprop/api/v1/institutional-proposal-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalAttachmentId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "fileDataId": "(val)",
  "sequenceNumber": "(val)",
  "attachmentNumber": "(val)",
  "attachmentTitle": "(val)",
  "attachmentTypeCode": "(val)",
  "fileName": "(val)",
  "contentType": "(val)",
  "comments": "(val)",
  "documentStatusCode": "(val)",
  "lastUpdateTimestamp": "(val)",
  "lastUpdateUser": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Institutional Proposal Attachments
PUT/instprop/api/v1/institutional-proposal-attachments/

Example URI

PUT /instprop/api/v1/institutional-proposal-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalAttachmentId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "fileDataId": "(val)",
    "sequenceNumber": "(val)",
    "attachmentNumber": "(val)",
    "attachmentTitle": "(val)",
    "attachmentTypeCode": "(val)",
    "fileName": "(val)",
    "contentType": "(val)",
    "comments": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalAttachmentId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "fileDataId": "(val)",
    "sequenceNumber": "(val)",
    "attachmentNumber": "(val)",
    "attachmentTitle": "(val)",
    "attachmentTypeCode": "(val)",
    "fileName": "(val)",
    "contentType": "(val)",
    "comments": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Institutional Proposal Attachments
PATCH/instprop/api/v1/institutional-proposal-attachments/(key)

Example URI

PATCH /instprop/api/v1/institutional-proposal-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalAttachmentId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "fileDataId": "(val)",
  "sequenceNumber": "(val)",
  "attachmentNumber": "(val)",
  "attachmentTitle": "(val)",
  "attachmentTypeCode": "(val)",
  "fileName": "(val)",
  "contentType": "(val)",
  "comments": "(val)",
  "documentStatusCode": "(val)",
  "lastUpdateTimestamp": "(val)",
  "lastUpdateUser": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "proposalAttachmentId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "fileDataId": "(val)",
  "sequenceNumber": "(val)",
  "attachmentNumber": "(val)",
  "attachmentTitle": "(val)",
  "attachmentTypeCode": "(val)",
  "fileName": "(val)",
  "contentType": "(val)",
  "comments": "(val)",
  "documentStatusCode": "(val)",
  "lastUpdateTimestamp": "(val)",
  "lastUpdateUser": "(val)",
  "_primaryKey": "(val)"
}

Insert Institutional Proposal Attachments
POST/instprop/api/v1/institutional-proposal-attachments/

Example URI

POST /instprop/api/v1/institutional-proposal-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalAttachmentId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "fileDataId": "(val)",
  "sequenceNumber": "(val)",
  "attachmentNumber": "(val)",
  "attachmentTitle": "(val)",
  "attachmentTypeCode": "(val)",
  "fileName": "(val)",
  "contentType": "(val)",
  "comments": "(val)",
  "documentStatusCode": "(val)",
  "lastUpdateTimestamp": "(val)",
  "lastUpdateUser": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "proposalAttachmentId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "fileDataId": "(val)",
  "sequenceNumber": "(val)",
  "attachmentNumber": "(val)",
  "attachmentTitle": "(val)",
  "attachmentTypeCode": "(val)",
  "fileName": "(val)",
  "contentType": "(val)",
  "comments": "(val)",
  "documentStatusCode": "(val)",
  "lastUpdateTimestamp": "(val)",
  "lastUpdateUser": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Institutional Proposal Attachments
POST/instprop/api/v1/institutional-proposal-attachments/

Example URI

POST /instprop/api/v1/institutional-proposal-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalAttachmentId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "fileDataId": "(val)",
    "sequenceNumber": "(val)",
    "attachmentNumber": "(val)",
    "attachmentTitle": "(val)",
    "attachmentTypeCode": "(val)",
    "fileName": "(val)",
    "contentType": "(val)",
    "comments": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalAttachmentId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "fileDataId": "(val)",
    "sequenceNumber": "(val)",
    "attachmentNumber": "(val)",
    "attachmentTitle": "(val)",
    "attachmentTypeCode": "(val)",
    "fileName": "(val)",
    "contentType": "(val)",
    "comments": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "proposalAttachmentId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "fileDataId": "(val)",
    "sequenceNumber": "(val)",
    "attachmentNumber": "(val)",
    "attachmentTitle": "(val)",
    "attachmentTypeCode": "(val)",
    "fileName": "(val)",
    "contentType": "(val)",
    "comments": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalAttachmentId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "fileDataId": "(val)",
    "sequenceNumber": "(val)",
    "attachmentNumber": "(val)",
    "attachmentTitle": "(val)",
    "attachmentTypeCode": "(val)",
    "fileName": "(val)",
    "contentType": "(val)",
    "comments": "(val)",
    "documentStatusCode": "(val)",
    "lastUpdateTimestamp": "(val)",
    "lastUpdateUser": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Institutional Proposal Attachments by Key
DELETE/instprop/api/v1/institutional-proposal-attachments/(key)

Example URI

DELETE /instprop/api/v1/institutional-proposal-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Attachments
DELETE/instprop/api/v1/institutional-proposal-attachments/

Example URI

DELETE /instprop/api/v1/institutional-proposal-attachments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Attachments with Matching
DELETE/instprop/api/v1/institutional-proposal-attachments/

Example URI

DELETE /instprop/api/v1/institutional-proposal-attachments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

proposalAttachmentId
string (optional) 
proposalId
string (optional) 
proposalNumber
string (optional) 
fileDataId
string (optional) 
sequenceNumber
string (optional) 
attachmentNumber
string (optional) 
attachmentTitle
string (optional) 

Description. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.

attachmentTypeCode
string (optional) 

Code. Maximum length is 3. Validating pattern is ^[0-9]*$.

fileName
string (optional) 

Id. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.

contentType
string (optional) 
comments
string (optional) 

Comments. Maximum length is 2000. Validating pattern is ^[\p{Graph}\p{Space}]*$.

documentStatusCode
string (optional) 
lastUpdateTimestamp
string (optional) 

The creation or last modification timestamp. Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

lastUpdateUser
string (optional) 

The user who created or last modified the object. Maximum length is 60. Validating pattern is ^[\p{Graph}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Institutional Proposal Comments

Get Institutional Proposal Comments by Key
GET/instprop/api/v1/institutional-proposal-comments/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-comments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalCommentsId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "commentTypeCode": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Comments
GET/instprop/api/v1/institutional-proposal-comments/

Example URI

GET /instprop/api/v1/institutional-proposal-comments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Comments with Filtering
GET/instprop/api/v1/institutional-proposal-comments/

Example URI

GET /instprop/api/v1/institutional-proposal-comments/
URI Parameters
HideShow
proposalCommentsId
string (optional) 

Proposal Comments Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

proposalId
string (optional) 

Proposal Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

proposalNumber
string (optional) 

Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.

commentTypeCode
string (optional) 

Comment Type Code. Maximum length is 22. Validating pattern is ^[A-Za-z0-9-]*$.

comments
string (optional) 

Comments. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Comments
GET/instprop/api/v1/institutional-proposal-comments/

Example URI

GET /instprop/api/v1/institutional-proposal-comments/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalCommentsId",
    "proposalId",
    "proposalNumber",
    "sequenceNumber",
    "commentTypeCode",
    "comments"
  ],
  "primaryKey": "proposalCommentsId"
}

Get Blueprint API specification for Institutional Proposal Comments
GET/instprop/api/v1/institutional-proposal-comments/

Example URI

GET /instprop/api/v1/institutional-proposal-comments/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Comments.md"
transfer-encoding: chunked

Update Institutional Proposal Comments
PUT/instprop/api/v1/institutional-proposal-comments/(key)

Example URI

PUT /instprop/api/v1/institutional-proposal-comments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalCommentsId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "commentTypeCode": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Institutional Proposal Comments
PUT/instprop/api/v1/institutional-proposal-comments/

Example URI

PUT /instprop/api/v1/institutional-proposal-comments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Institutional Proposal Comments
PATCH/instprop/api/v1/institutional-proposal-comments/(key)

Example URI

PATCH /instprop/api/v1/institutional-proposal-comments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalCommentsId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "commentTypeCode": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "proposalCommentsId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "commentTypeCode": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Institutional Proposal Comments
POST/instprop/api/v1/institutional-proposal-comments/

Example URI

POST /instprop/api/v1/institutional-proposal-comments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalCommentsId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "commentTypeCode": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "proposalCommentsId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "commentTypeCode": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Institutional Proposal Comments
POST/instprop/api/v1/institutional-proposal-comments/

Example URI

POST /instprop/api/v1/institutional-proposal-comments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Institutional Proposal Comments by Key
DELETE/instprop/api/v1/institutional-proposal-comments/(key)

Example URI

DELETE /instprop/api/v1/institutional-proposal-comments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Comments
DELETE/instprop/api/v1/institutional-proposal-comments/

Example URI

DELETE /instprop/api/v1/institutional-proposal-comments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Comments with Matching
DELETE/instprop/api/v1/institutional-proposal-comments/

Example URI

DELETE /instprop/api/v1/institutional-proposal-comments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

proposalCommentsId
string (optional) 

Proposal Comments Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

proposalId
string (optional) 

Proposal Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

proposalNumber
string (optional) 

Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.

commentTypeCode
string (optional) 

Comment Type Code. Maximum length is 22. Validating pattern is ^[A-Za-z0-9-]*$.

comments
string (optional) 

Comments. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Institutional Proposal Cost Shares

Get Institutional Proposal Cost Shares by Key
GET/instprop/api/v1/institutional-proposal-cost-shares/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-cost-shares/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalCostShareId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "projectPeriod": "(val)",
  "costSharePercentage": "(val)",
  "costShareTypeCode": "(val)",
  "sourceAccount": "(val)",
  "amount": "(val)",
  "unitNumber": "(val)",
  "institutionalProposal.proposalId": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Cost Shares
GET/instprop/api/v1/institutional-proposal-cost-shares/

Example URI

GET /instprop/api/v1/institutional-proposal-cost-shares/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalCostShareId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "projectPeriod": "(val)",
    "costSharePercentage": "(val)",
    "costShareTypeCode": "(val)",
    "sourceAccount": "(val)",
    "amount": "(val)",
    "unitNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCostShareId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "projectPeriod": "(val)",
    "costSharePercentage": "(val)",
    "costShareTypeCode": "(val)",
    "sourceAccount": "(val)",
    "amount": "(val)",
    "unitNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Cost Shares with Filtering
GET/instprop/api/v1/institutional-proposal-cost-shares/

Example URI

GET /instprop/api/v1/institutional-proposal-cost-shares/
URI Parameters
HideShow
proposalCostShareId
string (optional) 

Proposal Cost Share Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

proposalNumber
string (optional) 

Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.

projectPeriod
string (optional) 

Project Period. Maximum length is 4. Validating pattern is ^[A-Za-z0-9]*$.

costSharePercentage
string (optional) 

Cost Share Percentage. Maximum length is 10. Validating pattern is ^([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.

costShareTypeCode
string (optional) 

Cost Share Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.

sourceAccount
string (optional) 

Source Account. Maximum length is 32. Validating pattern is ^[\p{Graph}\p{Space}]*$.

amount
string (optional) 

Amount. Maximum length is 12. Validating pattern is ^([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.

unitNumber
string (optional) 

Unit Number. Maximum length is 20. Validating pattern is ^[\p{Graph}]*$.

institutionalProposal.proposalId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalCostShareId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "projectPeriod": "(val)",
    "costSharePercentage": "(val)",
    "costShareTypeCode": "(val)",
    "sourceAccount": "(val)",
    "amount": "(val)",
    "unitNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCostShareId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "projectPeriod": "(val)",
    "costSharePercentage": "(val)",
    "costShareTypeCode": "(val)",
    "sourceAccount": "(val)",
    "amount": "(val)",
    "unitNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Cost Shares
GET/instprop/api/v1/institutional-proposal-cost-shares/

Example URI

GET /instprop/api/v1/institutional-proposal-cost-shares/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalCostShareId",
    "proposalNumber",
    "sequenceNumber",
    "projectPeriod",
    "costSharePercentage",
    "costShareTypeCode",
    "sourceAccount",
    "amount",
    "unitNumber",
    "institutionalProposal.proposalId"
  ],
  "primaryKey": "proposalCostShareId"
}

Get Blueprint API specification for Institutional Proposal Cost Shares
GET/instprop/api/v1/institutional-proposal-cost-shares/

Example URI

GET /instprop/api/v1/institutional-proposal-cost-shares/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Cost Shares.md"
transfer-encoding: chunked

Institutional Proposal Custom Data

Get Institutional Proposal Custom Data by Key
GET/instprop/api/v1/institutional-proposal-custom-data/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-custom-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalCustomDataId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "customAttributeId": "(val)",
  "value": "(val)",
  "institutionalProposal.proposalId": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Custom Data
GET/instprop/api/v1/institutional-proposal-custom-data/

Example URI

GET /instprop/api/v1/institutional-proposal-custom-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalCustomDataId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "customAttributeId": "(val)",
    "value": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCustomDataId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "customAttributeId": "(val)",
    "value": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Custom Data with Filtering
GET/instprop/api/v1/institutional-proposal-custom-data/

Example URI

GET /instprop/api/v1/institutional-proposal-custom-data/
URI Parameters
HideShow
proposalCustomDataId
string (optional) 

Proposal Custom Data Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

proposalNumber
string (optional) 

Proposal Number. Maximum length is 10. Validating pattern is ^[A-Za-z0-9]*$.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.

customAttributeId
string (optional) 

Custom Attribute Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

value
string (optional) 

Value. Maximum length is 2000. Validating pattern is ^[\u0000-\uFFFF]*$.

institutionalProposal.proposalId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalCustomDataId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "customAttributeId": "(val)",
    "value": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCustomDataId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "customAttributeId": "(val)",
    "value": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Custom Data
GET/instprop/api/v1/institutional-proposal-custom-data/

Example URI

GET /instprop/api/v1/institutional-proposal-custom-data/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalCustomDataId",
    "proposalNumber",
    "sequenceNumber",
    "customAttributeId",
    "value",
    "institutionalProposal.proposalId"
  ],
  "primaryKey": "proposalCustomDataId"
}

Get Blueprint API specification for Institutional Proposal Custom Data
GET/instprop/api/v1/institutional-proposal-custom-data/

Example URI

GET /instprop/api/v1/institutional-proposal-custom-data/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Custom Data.md"
transfer-encoding: chunked

Institutional Proposal Notepads

Get Institutional Proposal Notepads by Key
GET/instprop/api/v1/institutional-proposal-notepads/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-notepads/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalNotepadId": "(val)",
  "proposalNumber": "(val)",
  "entryNumber": "(val)",
  "noteTopic": "(val)",
  "comments": "(val)",
  "restrictedView": "(val)",
  "noteId": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "institutionalProposal.proposalId": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Notepads
GET/instprop/api/v1/institutional-proposal-notepads/

Example URI

GET /instprop/api/v1/institutional-proposal-notepads/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalNotepadId": "(val)",
    "proposalNumber": "(val)",
    "entryNumber": "(val)",
    "noteTopic": "(val)",
    "comments": "(val)",
    "restrictedView": "(val)",
    "noteId": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalNotepadId": "(val)",
    "proposalNumber": "(val)",
    "entryNumber": "(val)",
    "noteTopic": "(val)",
    "comments": "(val)",
    "restrictedView": "(val)",
    "noteId": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Notepads with Filtering
GET/instprop/api/v1/institutional-proposal-notepads/

Example URI

GET /instprop/api/v1/institutional-proposal-notepads/
URI Parameters
HideShow
proposalNotepadId
string (optional) 

Proposal Notepad Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

proposalNumber
string (optional) 

Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

entryNumber
string (optional) 

Entry Number. Maximum length is 22. Validating pattern is ^[0-9]*$.

noteTopic
string (optional) 

Comments. Maximum length is 60. Validating pattern is ^[\p{Graph}\p{Space}]*$.

comments
string (optional) 

Comments. Maximum length is 4000. Validating pattern is ^[\p{Graph}\p{Space}]*$.

restrictedView
string (optional) 

Restricted View. Maximum length is 1. Validating pattern is .*.

noteId
string (optional) 
createTimestamp
string (optional) 

Posted Timestamp. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

createUser
string (optional) 
institutionalProposal.proposalId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalNotepadId": "(val)",
    "proposalNumber": "(val)",
    "entryNumber": "(val)",
    "noteTopic": "(val)",
    "comments": "(val)",
    "restrictedView": "(val)",
    "noteId": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalNotepadId": "(val)",
    "proposalNumber": "(val)",
    "entryNumber": "(val)",
    "noteTopic": "(val)",
    "comments": "(val)",
    "restrictedView": "(val)",
    "noteId": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Notepads
GET/instprop/api/v1/institutional-proposal-notepads/

Example URI

GET /instprop/api/v1/institutional-proposal-notepads/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalNotepadId",
    "proposalNumber",
    "entryNumber",
    "noteTopic",
    "comments",
    "restrictedView",
    "noteId",
    "createTimestamp",
    "createUser",
    "institutionalProposal.proposalId"
  ],
  "primaryKey": "proposalNotepadId"
}

Get Blueprint API specification for Institutional Proposal Notepads
GET/instprop/api/v1/institutional-proposal-notepads/

Example URI

GET /instprop/api/v1/institutional-proposal-notepads/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Notepads.md"
transfer-encoding: chunked

Institutional Proposal Person Credit Splits

Get Institutional Proposal Person Credit Splits by Key
GET/instprop/api/v1/institutional-proposal-person-credit-splits/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-person-credit-splits/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "institutionalProposalPersonCreditSplitId": "(val)",
  "institutionalProposalContactId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Person Credit Splits
GET/instprop/api/v1/institutional-proposal-person-credit-splits/

Example URI

GET /instprop/api/v1/institutional-proposal-person-credit-splits/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "institutionalProposalPersonCreditSplitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonCreditSplitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Person Credit Splits with Filtering
GET/instprop/api/v1/institutional-proposal-person-credit-splits/

Example URI

GET /instprop/api/v1/institutional-proposal-person-credit-splits/
URI Parameters
HideShow
institutionalProposalPersonCreditSplitId
string (optional) 
institutionalProposalContactId
string (optional) 
invCreditTypeCode
string (optional) 
credit
string (optional) 

Credit. Maximum length is 6. Validating pattern is ^([0-9]{0,4}.[0-9]{1,2}|[0-9]{1,4})$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "institutionalProposalPersonCreditSplitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonCreditSplitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Person Credit Splits
GET/instprop/api/v1/institutional-proposal-person-credit-splits/

Example URI

GET /instprop/api/v1/institutional-proposal-person-credit-splits/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "institutionalProposalPersonCreditSplitId",
    "institutionalProposalContactId",
    "invCreditTypeCode",
    "credit"
  ],
  "primaryKey": "institutionalProposalPersonCreditSplitId"
}

Get Blueprint API specification for Institutional Proposal Person Credit Splits
GET/instprop/api/v1/institutional-proposal-person-credit-splits/

Example URI

GET /instprop/api/v1/institutional-proposal-person-credit-splits/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Person Credit Splits.md"
transfer-encoding: chunked

Update Institutional Proposal Person Credit Splits
PUT/instprop/api/v1/institutional-proposal-person-credit-splits/(key)

Example URI

PUT /instprop/api/v1/institutional-proposal-person-credit-splits/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalPersonCreditSplitId": "(val)",
  "institutionalProposalContactId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Institutional Proposal Person Credit Splits
PUT/instprop/api/v1/institutional-proposal-person-credit-splits/

Example URI

PUT /instprop/api/v1/institutional-proposal-person-credit-splits/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "institutionalProposalPersonCreditSplitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonCreditSplitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Institutional Proposal Person Credit Splits
PATCH/instprop/api/v1/institutional-proposal-person-credit-splits/(key)

Example URI

PATCH /instprop/api/v1/institutional-proposal-person-credit-splits/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalPersonCreditSplitId": "(val)",
  "institutionalProposalContactId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "institutionalProposalPersonCreditSplitId": "(val)",
  "institutionalProposalContactId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Insert Institutional Proposal Person Credit Splits
POST/instprop/api/v1/institutional-proposal-person-credit-splits/

Example URI

POST /instprop/api/v1/institutional-proposal-person-credit-splits/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalPersonCreditSplitId": "(val)",
  "institutionalProposalContactId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "institutionalProposalPersonCreditSplitId": "(val)",
  "institutionalProposalContactId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Institutional Proposal Person Credit Splits
POST/instprop/api/v1/institutional-proposal-person-credit-splits/

Example URI

POST /instprop/api/v1/institutional-proposal-person-credit-splits/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "institutionalProposalPersonCreditSplitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonCreditSplitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "institutionalProposalPersonCreditSplitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonCreditSplitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Institutional Proposal Person Credit Splits by Key
DELETE/instprop/api/v1/institutional-proposal-person-credit-splits/(key)

Example URI

DELETE /instprop/api/v1/institutional-proposal-person-credit-splits/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Person Credit Splits
DELETE/instprop/api/v1/institutional-proposal-person-credit-splits/

Example URI

DELETE /instprop/api/v1/institutional-proposal-person-credit-splits/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Person Credit Splits with Matching
DELETE/instprop/api/v1/institutional-proposal-person-credit-splits/

Example URI

DELETE /instprop/api/v1/institutional-proposal-person-credit-splits/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

institutionalProposalPersonCreditSplitId
string (optional) 
institutionalProposalContactId
string (optional) 
invCreditTypeCode
string (optional) 
credit
string (optional) 

Credit. Maximum length is 6. Validating pattern is ^([0-9]{0,4}.[0-9]{1,2}|[0-9]{1,4})$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Institutional Proposal Person Mass Changes

Get Institutional Proposal Person Mass Changes by Key
GET/instprop/api/v1/institutional-proposal-person-mass-changes/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-person-mass-changes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "institutionalProposalPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "unitContact": "(val)",
  "mailingInformation": "(val)",
  "ipReviewer": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Person Mass Changes
GET/instprop/api/v1/institutional-proposal-person-mass-changes/

Example URI

GET /instprop/api/v1/institutional-proposal-person-mass-changes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "institutionalProposalPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "mailingInformation": "(val)",
    "ipReviewer": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "mailingInformation": "(val)",
    "ipReviewer": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Person Mass Changes with Filtering
GET/instprop/api/v1/institutional-proposal-person-mass-changes/

Example URI

GET /instprop/api/v1/institutional-proposal-person-mass-changes/
URI Parameters
HideShow
institutionalProposalPersonMassChangeId
string (optional) 

Institutional Proposal Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.

personMassChangeId
string (optional) 

Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.

investigator
string (optional) 

Investigator. Maximum length is 1. Validating pattern is .*.

keyStudyPerson
string (optional) 

Key Study Person. Maximum length is 1. Validating pattern is .*.

unitContact
string (optional) 

Unit Contact. Maximum length is 1. Validating pattern is .*.

mailingInformation
string (optional) 

Mailing Information. Maximum length is 1. Validating pattern is .*.

ipReviewer
string (optional) 

IP Reviewer. Maximum length is 1. Validating pattern is .*.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "institutionalProposalPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "mailingInformation": "(val)",
    "ipReviewer": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "mailingInformation": "(val)",
    "ipReviewer": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Person Mass Changes
GET/instprop/api/v1/institutional-proposal-person-mass-changes/

Example URI

GET /instprop/api/v1/institutional-proposal-person-mass-changes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "institutionalProposalPersonMassChangeId",
    "personMassChangeId",
    "investigator",
    "keyStudyPerson",
    "unitContact",
    "mailingInformation",
    "ipReviewer"
  ],
  "primaryKey": "institutionalProposalPersonMassChangeId"
}

Get Blueprint API specification for Institutional Proposal Person Mass Changes
GET/instprop/api/v1/institutional-proposal-person-mass-changes/

Example URI

GET /instprop/api/v1/institutional-proposal-person-mass-changes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Person Mass Changes.md"
transfer-encoding: chunked

Update Institutional Proposal Person Mass Changes
PUT/instprop/api/v1/institutional-proposal-person-mass-changes/(key)

Example URI

PUT /instprop/api/v1/institutional-proposal-person-mass-changes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "unitContact": "(val)",
  "mailingInformation": "(val)",
  "ipReviewer": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Institutional Proposal Person Mass Changes
PUT/instprop/api/v1/institutional-proposal-person-mass-changes/

Example URI

PUT /instprop/api/v1/institutional-proposal-person-mass-changes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "institutionalProposalPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "mailingInformation": "(val)",
    "ipReviewer": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "mailingInformation": "(val)",
    "ipReviewer": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Institutional Proposal Person Mass Changes
PATCH/instprop/api/v1/institutional-proposal-person-mass-changes/(key)

Example URI

PATCH /instprop/api/v1/institutional-proposal-person-mass-changes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "unitContact": "(val)",
  "mailingInformation": "(val)",
  "ipReviewer": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "institutionalProposalPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "unitContact": "(val)",
  "mailingInformation": "(val)",
  "ipReviewer": "(val)",
  "_primaryKey": "(val)"
}

Insert Institutional Proposal Person Mass Changes
POST/instprop/api/v1/institutional-proposal-person-mass-changes/

Example URI

POST /instprop/api/v1/institutional-proposal-person-mass-changes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "unitContact": "(val)",
  "mailingInformation": "(val)",
  "ipReviewer": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "institutionalProposalPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "unitContact": "(val)",
  "mailingInformation": "(val)",
  "ipReviewer": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Institutional Proposal Person Mass Changes
POST/instprop/api/v1/institutional-proposal-person-mass-changes/

Example URI

POST /instprop/api/v1/institutional-proposal-person-mass-changes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "institutionalProposalPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "mailingInformation": "(val)",
    "ipReviewer": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "mailingInformation": "(val)",
    "ipReviewer": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "institutionalProposalPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "mailingInformation": "(val)",
    "ipReviewer": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "unitContact": "(val)",
    "mailingInformation": "(val)",
    "ipReviewer": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Institutional Proposal Person Mass Changes by Key
DELETE/instprop/api/v1/institutional-proposal-person-mass-changes/(key)

Example URI

DELETE /instprop/api/v1/institutional-proposal-person-mass-changes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Person Mass Changes
DELETE/instprop/api/v1/institutional-proposal-person-mass-changes/

Example URI

DELETE /instprop/api/v1/institutional-proposal-person-mass-changes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Person Mass Changes with Matching
DELETE/instprop/api/v1/institutional-proposal-person-mass-changes/

Example URI

DELETE /instprop/api/v1/institutional-proposal-person-mass-changes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

institutionalProposalPersonMassChangeId
string (optional) 

Institutional Proposal Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.

personMassChangeId
string (optional) 

Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.

investigator
string (optional) 

Investigator. Maximum length is 1. Validating pattern is .*.

keyStudyPerson
string (optional) 

Key Study Person. Maximum length is 1. Validating pattern is .*.

unitContact
string (optional) 

Unit Contact. Maximum length is 1. Validating pattern is .*.

mailingInformation
string (optional) 

Mailing Information. Maximum length is 1. Validating pattern is .*.

ipReviewer
string (optional) 

IP Reviewer. Maximum length is 1. Validating pattern is .*.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Institutional Proposal Person Unit Credit Splits

Get Institutional Proposal Person Unit Credit Splits by Key
GET/instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "institutionalProposalPersonUnitCreditSplitId": "(val)",
  "institutionalProposalPersonUnitId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Person Unit Credit Splits
GET/instprop/api/v1/institutional-proposal-person-unit-credit-splits/

Example URI

GET /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "institutionalProposalPersonUnitCreditSplitId": "(val)",
    "institutionalProposalPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonUnitCreditSplitId": "(val)",
    "institutionalProposalPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Person Unit Credit Splits with Filtering
GET/instprop/api/v1/institutional-proposal-person-unit-credit-splits/

Example URI

GET /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
URI Parameters
HideShow
institutionalProposalPersonUnitCreditSplitId
string (optional) 
institutionalProposalPersonUnitId
string (optional) 
invCreditTypeCode
string (optional) 
credit
string (optional) 

Credit. Maximum length is 6. Validating pattern is ^([0-9]{0,4}.[0-9]{1,2}|[0-9]{1,4})$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "institutionalProposalPersonUnitCreditSplitId": "(val)",
    "institutionalProposalPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonUnitCreditSplitId": "(val)",
    "institutionalProposalPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Person Unit Credit Splits
GET/instprop/api/v1/institutional-proposal-person-unit-credit-splits/

Example URI

GET /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "institutionalProposalPersonUnitCreditSplitId",
    "institutionalProposalPersonUnitId",
    "invCreditTypeCode",
    "credit"
  ],
  "primaryKey": "institutionalProposalPersonUnitCreditSplitId"
}

Get Blueprint API specification for Institutional Proposal Person Unit Credit Splits
GET/instprop/api/v1/institutional-proposal-person-unit-credit-splits/

Example URI

GET /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Person Unit Credit Splits.md"
transfer-encoding: chunked

Update Institutional Proposal Person Unit Credit Splits
PUT/instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)

Example URI

PUT /instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalPersonUnitCreditSplitId": "(val)",
  "institutionalProposalPersonUnitId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Institutional Proposal Person Unit Credit Splits
PUT/instprop/api/v1/institutional-proposal-person-unit-credit-splits/

Example URI

PUT /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "institutionalProposalPersonUnitCreditSplitId": "(val)",
    "institutionalProposalPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonUnitCreditSplitId": "(val)",
    "institutionalProposalPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Institutional Proposal Person Unit Credit Splits
PATCH/instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)

Example URI

PATCH /instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalPersonUnitCreditSplitId": "(val)",
  "institutionalProposalPersonUnitId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "institutionalProposalPersonUnitCreditSplitId": "(val)",
  "institutionalProposalPersonUnitId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Insert Institutional Proposal Person Unit Credit Splits
POST/instprop/api/v1/institutional-proposal-person-unit-credit-splits/

Example URI

POST /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalPersonUnitCreditSplitId": "(val)",
  "institutionalProposalPersonUnitId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "institutionalProposalPersonUnitCreditSplitId": "(val)",
  "institutionalProposalPersonUnitId": "(val)",
  "invCreditTypeCode": "(val)",
  "credit": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Institutional Proposal Person Unit Credit Splits
POST/instprop/api/v1/institutional-proposal-person-unit-credit-splits/

Example URI

POST /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "institutionalProposalPersonUnitCreditSplitId": "(val)",
    "institutionalProposalPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonUnitCreditSplitId": "(val)",
    "institutionalProposalPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "institutionalProposalPersonUnitCreditSplitId": "(val)",
    "institutionalProposalPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonUnitCreditSplitId": "(val)",
    "institutionalProposalPersonUnitId": "(val)",
    "invCreditTypeCode": "(val)",
    "credit": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Institutional Proposal Person Unit Credit Splits by Key
DELETE/instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)

Example URI

DELETE /instprop/api/v1/institutional-proposal-person-unit-credit-splits/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Person Unit Credit Splits
DELETE/instprop/api/v1/institutional-proposal-person-unit-credit-splits/

Example URI

DELETE /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Person Unit Credit Splits with Matching
DELETE/instprop/api/v1/institutional-proposal-person-unit-credit-splits/

Example URI

DELETE /instprop/api/v1/institutional-proposal-person-unit-credit-splits/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

institutionalProposalPersonUnitCreditSplitId
string (optional) 
institutionalProposalPersonUnitId
string (optional) 
invCreditTypeCode
string (optional) 
credit
string (optional) 

Credit. Maximum length is 6. Validating pattern is ^([0-9]{0,4}.[0-9]{1,2}|[0-9]{1,4})$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Institutional Proposal Person Units

Get Institutional Proposal Person Units by Key
GET/instprop/api/v1/institutional-proposal-person-units/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-person-units/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "institutionalProposalPersonUnitId": "(val)",
  "institutionalProposalContactId": "(val)",
  "unitNumber": "(val)",
  "leadUnit": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Person Units
GET/instprop/api/v1/institutional-proposal-person-units/

Example URI

GET /instprop/api/v1/institutional-proposal-person-units/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "institutionalProposalPersonUnitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonUnitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Person Units with Filtering
GET/instprop/api/v1/institutional-proposal-person-units/

Example URI

GET /instprop/api/v1/institutional-proposal-person-units/
URI Parameters
HideShow
institutionalProposalPersonUnitId
string (optional) 

InstitutionalProposalPersonUnit ID. Maximum length is 8. Validating pattern is ^[0-9]*$.

institutionalProposalContactId
string (optional) 
unitNumber
string (optional) 

Unit Number. Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.

leadUnit
string (optional) 

Lead Unit flag. Maximum length is 1. Validating pattern is .*.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "institutionalProposalPersonUnitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonUnitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Person Units
GET/instprop/api/v1/institutional-proposal-person-units/

Example URI

GET /instprop/api/v1/institutional-proposal-person-units/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "institutionalProposalPersonUnitId",
    "institutionalProposalContactId",
    "unitNumber",
    "leadUnit"
  ],
  "primaryKey": "institutionalProposalPersonUnitId"
}

Get Blueprint API specification for Institutional Proposal Person Units
GET/instprop/api/v1/institutional-proposal-person-units/

Example URI

GET /instprop/api/v1/institutional-proposal-person-units/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Person Units.md"
transfer-encoding: chunked

Update Institutional Proposal Person Units
PUT/instprop/api/v1/institutional-proposal-person-units/(key)

Example URI

PUT /instprop/api/v1/institutional-proposal-person-units/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalPersonUnitId": "(val)",
  "institutionalProposalContactId": "(val)",
  "unitNumber": "(val)",
  "leadUnit": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Institutional Proposal Person Units
PUT/instprop/api/v1/institutional-proposal-person-units/

Example URI

PUT /instprop/api/v1/institutional-proposal-person-units/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "institutionalProposalPersonUnitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonUnitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Institutional Proposal Person Units
PATCH/instprop/api/v1/institutional-proposal-person-units/(key)

Example URI

PATCH /instprop/api/v1/institutional-proposal-person-units/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalPersonUnitId": "(val)",
  "institutionalProposalContactId": "(val)",
  "unitNumber": "(val)",
  "leadUnit": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "institutionalProposalPersonUnitId": "(val)",
  "institutionalProposalContactId": "(val)",
  "unitNumber": "(val)",
  "leadUnit": "(val)",
  "_primaryKey": "(val)"
}

Insert Institutional Proposal Person Units
POST/instprop/api/v1/institutional-proposal-person-units/

Example URI

POST /instprop/api/v1/institutional-proposal-person-units/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalPersonUnitId": "(val)",
  "institutionalProposalContactId": "(val)",
  "unitNumber": "(val)",
  "leadUnit": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "institutionalProposalPersonUnitId": "(val)",
  "institutionalProposalContactId": "(val)",
  "unitNumber": "(val)",
  "leadUnit": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Institutional Proposal Person Units
POST/instprop/api/v1/institutional-proposal-person-units/

Example URI

POST /instprop/api/v1/institutional-proposal-person-units/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "institutionalProposalPersonUnitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonUnitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "institutionalProposalPersonUnitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalPersonUnitId": "(val)",
    "institutionalProposalContactId": "(val)",
    "unitNumber": "(val)",
    "leadUnit": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Institutional Proposal Person Units by Key
DELETE/instprop/api/v1/institutional-proposal-person-units/(key)

Example URI

DELETE /instprop/api/v1/institutional-proposal-person-units/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Person Units
DELETE/instprop/api/v1/institutional-proposal-person-units/

Example URI

DELETE /instprop/api/v1/institutional-proposal-person-units/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Person Units with Matching
DELETE/instprop/api/v1/institutional-proposal-person-units/

Example URI

DELETE /instprop/api/v1/institutional-proposal-person-units/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

institutionalProposalPersonUnitId
string (optional) 

InstitutionalProposalPersonUnit ID. Maximum length is 8. Validating pattern is ^[0-9]*$.

institutionalProposalContactId
string (optional) 
unitNumber
string (optional) 

Unit Number. Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.

leadUnit
string (optional) 

Lead Unit flag. Maximum length is 1. Validating pattern is .*.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Institutional Proposal Persons

Get Institutional Proposal Persons by Key
GET/instprop/api/v1/institutional-proposal-persons/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-persons/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "institutionalProposalContactId": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "fullName": "(val)",
  "academicYearEffort": "(val)",
  "calendarYearEffort": "(val)",
  "summerEffort": "(val)",
  "totalEffort": "(val)",
  "faculty": "(val)",
  "includeInCreditAllocation": "(val)",
  "roleCode": "(val)",
  "keyPersonRole": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "institutionalProposal.proposalId": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Persons
GET/instprop/api/v1/institutional-proposal-persons/

Example URI

GET /instprop/api/v1/institutional-proposal-persons/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "institutionalProposalContactId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "academicYearEffort": "(val)",
    "calendarYearEffort": "(val)",
    "summerEffort": "(val)",
    "totalEffort": "(val)",
    "faculty": "(val)",
    "includeInCreditAllocation": "(val)",
    "roleCode": "(val)",
    "keyPersonRole": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalContactId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "academicYearEffort": "(val)",
    "calendarYearEffort": "(val)",
    "summerEffort": "(val)",
    "totalEffort": "(val)",
    "faculty": "(val)",
    "includeInCreditAllocation": "(val)",
    "roleCode": "(val)",
    "keyPersonRole": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Persons with Filtering
GET/instprop/api/v1/institutional-proposal-persons/

Example URI

GET /instprop/api/v1/institutional-proposal-persons/
URI Parameters
HideShow
institutionalProposalContactId
string (optional) 

InstitutionalProposal Contact ID. Maximum length is 8. Validating pattern is ^[0-9]*$.

personId
string (optional) 
rolodexId
string (optional) 
fullName
string (optional) 

Full Name. Maximum length is 90. Validating pattern is ^[\p{Graph}\p{Space}]*$.

academicYearEffort
string (optional) 

Academic Year Effort. Maximum length is 7. Validating pattern is ^([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.

calendarYearEffort
string (optional) 

Calendar Year Effort. Maximum length is 7. Validating pattern is ^([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.

summerEffort
string (optional) 

Summer Effort. Maximum length is 7. Validating pattern is ^([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.

totalEffort
string (optional) 

Total Effort. Maximum length is 7. Validating pattern is ^([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.

faculty
string (optional) 

Faculty flag. Maximum length is 1. Validating pattern is .*.

includeInCreditAllocation
string (optional) 

Include in Credit Allocation. Maximum length is 1. Validating pattern is .*.

roleCode
string (optional) 
keyPersonRole
string (optional) 

Project Role. Maximum length is 60. Validating pattern is .*.

proposalNumber
string (optional) 

Institutional Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 4. Validating pattern is ^[0-9]*$.

institutionalProposal.proposalId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "institutionalProposalContactId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "academicYearEffort": "(val)",
    "calendarYearEffort": "(val)",
    "summerEffort": "(val)",
    "totalEffort": "(val)",
    "faculty": "(val)",
    "includeInCreditAllocation": "(val)",
    "roleCode": "(val)",
    "keyPersonRole": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalContactId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "academicYearEffort": "(val)",
    "calendarYearEffort": "(val)",
    "summerEffort": "(val)",
    "totalEffort": "(val)",
    "faculty": "(val)",
    "includeInCreditAllocation": "(val)",
    "roleCode": "(val)",
    "keyPersonRole": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Persons
GET/instprop/api/v1/institutional-proposal-persons/

Example URI

GET /instprop/api/v1/institutional-proposal-persons/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "institutionalProposalContactId",
    "personId",
    "rolodexId",
    "fullName",
    "academicYearEffort",
    "calendarYearEffort",
    "summerEffort",
    "totalEffort",
    "faculty",
    "includeInCreditAllocation",
    "roleCode",
    "keyPersonRole",
    "proposalNumber",
    "sequenceNumber",
    "institutionalProposal.proposalId"
  ],
  "primaryKey": "institutionalProposalContactId"
}

Get Blueprint API specification for Institutional Proposal Persons
GET/instprop/api/v1/institutional-proposal-persons/

Example URI

GET /instprop/api/v1/institutional-proposal-persons/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Persons.md"
transfer-encoding: chunked

Update Institutional Proposal Persons
PUT/instprop/api/v1/institutional-proposal-persons/(key)

Example URI

PUT /instprop/api/v1/institutional-proposal-persons/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalContactId": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "fullName": "(val)",
  "academicYearEffort": "(val)",
  "calendarYearEffort": "(val)",
  "summerEffort": "(val)",
  "totalEffort": "(val)",
  "faculty": "(val)",
  "includeInCreditAllocation": "(val)",
  "roleCode": "(val)",
  "keyPersonRole": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "institutionalProposal.proposalId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Institutional Proposal Persons
PUT/instprop/api/v1/institutional-proposal-persons/

Example URI

PUT /instprop/api/v1/institutional-proposal-persons/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "institutionalProposalContactId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "academicYearEffort": "(val)",
    "calendarYearEffort": "(val)",
    "summerEffort": "(val)",
    "totalEffort": "(val)",
    "faculty": "(val)",
    "includeInCreditAllocation": "(val)",
    "roleCode": "(val)",
    "keyPersonRole": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalContactId": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "fullName": "(val)",
    "academicYearEffort": "(val)",
    "calendarYearEffort": "(val)",
    "summerEffort": "(val)",
    "totalEffort": "(val)",
    "faculty": "(val)",
    "includeInCreditAllocation": "(val)",
    "roleCode": "(val)",
    "keyPersonRole": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Institutional Proposal Persons
PATCH/instprop/api/v1/institutional-proposal-persons/(key)

Example URI

PATCH /instprop/api/v1/institutional-proposal-persons/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "institutionalProposalContactId": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "fullName": "(val)",
  "academicYearEffort": "(val)",
  "calendarYearEffort": "(val)",
  "summerEffort": "(val)",
  "totalEffort": "(val)",
  "faculty": "(val)",
  "includeInCreditAllocation": "(val)",
  "roleCode": "(val)",
  "keyPersonRole": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "institutionalProposal.proposalId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "institutionalProposalContactId": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "fullName": "(val)",
  "academicYearEffort": "(val)",
  "calendarYearEffort": "(val)",
  "summerEffort": "(val)",
  "totalEffort": "(val)",
  "faculty": "(val)",
  "includeInCreditAllocation": "(val)",
  "roleCode": "(val)",
  "keyPersonRole": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "institutionalProposal.proposalId": "(val)",
  "_primaryKey": "(val)"
}

Institutional Proposal Science Keywords

Get Institutional Proposal Science Keywords by Key
GET/instprop/api/v1/institutional-proposal-science-keywords/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-science-keywords/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalScienceKeywordId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "scienceKeywordCode": "(val)",
  "institutionalProposal.proposalId": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Science Keywords
GET/instprop/api/v1/institutional-proposal-science-keywords/

Example URI

GET /instprop/api/v1/institutional-proposal-science-keywords/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalScienceKeywordId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "scienceKeywordCode": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalScienceKeywordId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "scienceKeywordCode": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Science Keywords with Filtering
GET/instprop/api/v1/institutional-proposal-science-keywords/

Example URI

GET /instprop/api/v1/institutional-proposal-science-keywords/
URI Parameters
HideShow
proposalScienceKeywordId
string (optional) 

Proposal Science Code Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

proposalNumber
string (optional) 

Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.

scienceKeywordCode
string (optional) 

Science Code. Maximum length is 15. Validating pattern is ^[A-Za-z0-9]*$.

institutionalProposal.proposalId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalScienceKeywordId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "scienceKeywordCode": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalScienceKeywordId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "scienceKeywordCode": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Science Keywords
GET/instprop/api/v1/institutional-proposal-science-keywords/

Example URI

GET /instprop/api/v1/institutional-proposal-science-keywords/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalScienceKeywordId",
    "proposalNumber",
    "sequenceNumber",
    "scienceKeywordCode",
    "institutionalProposal.proposalId"
  ],
  "primaryKey": "proposalScienceKeywordId"
}

Get Blueprint API specification for Institutional Proposal Science Keywords
GET/instprop/api/v1/institutional-proposal-science-keywords/

Example URI

GET /instprop/api/v1/institutional-proposal-science-keywords/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Science Keywords.md"
transfer-encoding: chunked

Institutional Proposal Special Review Exemptions

Get Institutional Proposal Special Review Exemptions by Key
GET/instprop/api/v1/institutional-proposal-special-review-exemptions/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-special-review-exemptions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalSpecialReviewExemptionId": "(val)",
  "exemptionTypeCode": "(val)",
  "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Special Review Exemptions
GET/instprop/api/v1/institutional-proposal-special-review-exemptions/

Example URI

GET /instprop/api/v1/institutional-proposal-special-review-exemptions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Special Review Exemptions with Filtering
GET/instprop/api/v1/institutional-proposal-special-review-exemptions/

Example URI

GET /instprop/api/v1/institutional-proposal-special-review-exemptions/
URI Parameters
HideShow
proposalSpecialReviewExemptionId
string (optional) 

Proposal Special Review Exemption Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

exemptionTypeCode
string (optional) 

Exemption #. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

institutionalProposalSpecialReview.proposalSpecialReviewId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Special Review Exemptions
GET/instprop/api/v1/institutional-proposal-special-review-exemptions/

Example URI

GET /instprop/api/v1/institutional-proposal-special-review-exemptions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalSpecialReviewExemptionId",
    "exemptionTypeCode",
    "institutionalProposalSpecialReview.proposalSpecialReviewId"
  ],
  "primaryKey": "proposalSpecialReviewExemptionId"
}

Get Blueprint API specification for Institutional Proposal Special Review Exemptions
GET/instprop/api/v1/institutional-proposal-special-review-exemptions/

Example URI

GET /instprop/api/v1/institutional-proposal-special-review-exemptions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Special Review Exemptions.md"
transfer-encoding: chunked

Update Institutional Proposal Special Review Exemptions
PUT/instprop/api/v1/institutional-proposal-special-review-exemptions/(key)

Example URI

PUT /instprop/api/v1/institutional-proposal-special-review-exemptions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalSpecialReviewExemptionId": "(val)",
  "exemptionTypeCode": "(val)",
  "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Institutional Proposal Special Review Exemptions
PUT/instprop/api/v1/institutional-proposal-special-review-exemptions/

Example URI

PUT /instprop/api/v1/institutional-proposal-special-review-exemptions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Institutional Proposal Special Review Exemptions
PATCH/instprop/api/v1/institutional-proposal-special-review-exemptions/(key)

Example URI

PATCH /instprop/api/v1/institutional-proposal-special-review-exemptions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalSpecialReviewExemptionId": "(val)",
  "exemptionTypeCode": "(val)",
  "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "proposalSpecialReviewExemptionId": "(val)",
  "exemptionTypeCode": "(val)",
  "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
  "_primaryKey": "(val)"
}

Insert Institutional Proposal Special Review Exemptions
POST/instprop/api/v1/institutional-proposal-special-review-exemptions/

Example URI

POST /instprop/api/v1/institutional-proposal-special-review-exemptions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalSpecialReviewExemptionId": "(val)",
  "exemptionTypeCode": "(val)",
  "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "proposalSpecialReviewExemptionId": "(val)",
  "exemptionTypeCode": "(val)",
  "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Institutional Proposal Special Review Exemptions
POST/instprop/api/v1/institutional-proposal-special-review-exemptions/

Example URI

POST /instprop/api/v1/institutional-proposal-special-review-exemptions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "proposalSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "institutionalProposalSpecialReview.proposalSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Institutional Proposal Special Review Exemptions by Key
DELETE/instprop/api/v1/institutional-proposal-special-review-exemptions/(key)

Example URI

DELETE /instprop/api/v1/institutional-proposal-special-review-exemptions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Special Review Exemptions
DELETE/instprop/api/v1/institutional-proposal-special-review-exemptions/

Example URI

DELETE /instprop/api/v1/institutional-proposal-special-review-exemptions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Institutional Proposal Special Review Exemptions with Matching
DELETE/instprop/api/v1/institutional-proposal-special-review-exemptions/

Example URI

DELETE /instprop/api/v1/institutional-proposal-special-review-exemptions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

proposalSpecialReviewExemptionId
string (optional) 

Proposal Special Review Exemption Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

exemptionTypeCode
string (optional) 

Exemption #. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

institutionalProposalSpecialReview.proposalSpecialReviewId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Institutional Proposal Special Reviews

Get Institutional Proposal Special Reviews by Key
GET/instprop/api/v1/institutional-proposal-special-reviews/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-special-reviews/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalSpecialReviewId": "(val)",
  "specialReviewNumber": "(val)",
  "specialReviewTypeCode": "(val)",
  "approvalTypeCode": "(val)",
  "protocolNumber": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "expirationDate": "(val)",
  "comments": "(val)",
  "protocolStatus": "(val)",
  "sequenceOwner.proposalId": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Special Reviews
GET/instprop/api/v1/institutional-proposal-special-reviews/

Example URI

GET /instprop/api/v1/institutional-proposal-special-reviews/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalSpecialReviewId": "(val)",
    "specialReviewNumber": "(val)",
    "specialReviewTypeCode": "(val)",
    "approvalTypeCode": "(val)",
    "protocolNumber": "(val)",
    "applicationDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "comments": "(val)",
    "protocolStatus": "(val)",
    "sequenceOwner.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalSpecialReviewId": "(val)",
    "specialReviewNumber": "(val)",
    "specialReviewTypeCode": "(val)",
    "approvalTypeCode": "(val)",
    "protocolNumber": "(val)",
    "applicationDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "comments": "(val)",
    "protocolStatus": "(val)",
    "sequenceOwner.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Special Reviews with Filtering
GET/instprop/api/v1/institutional-proposal-special-reviews/

Example URI

GET /instprop/api/v1/institutional-proposal-special-reviews/
URI Parameters
HideShow
proposalSpecialReviewId
string (optional) 

Proposal Special Review Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

specialReviewNumber
string (optional) 

Special Review Number. Maximum length is 22. Validating pattern is ^[0-9]*$.

specialReviewTypeCode
string (optional) 

Special Review Type Code. Maximum length is 30. Validating pattern is ^[\p{Graph}]*$.

approvalTypeCode
string (optional) 

Approval Status Type Code. Maximum length is 30. Validating pattern is ^[\p{Graph}]*$.

protocolNumber
string (optional) 

Compliance Identifier. Maximum length is 20. Validating pattern is ^[\p{Graph}\p{Space}]*$.

applicationDate
string (optional) 

Application Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

approvalDate
string (optional) 

Approval Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

expirationDate
string (optional) 

Expiration Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

comments
string (optional) 

Comments. Maximum length is 2000. Validating pattern is .*.

protocolStatus
string (optional) 

Protocol Status. Maximum length is 200. Validating pattern is ^[\u0000-\uFFFF]*$.

sequenceOwner.proposalId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalSpecialReviewId": "(val)",
    "specialReviewNumber": "(val)",
    "specialReviewTypeCode": "(val)",
    "approvalTypeCode": "(val)",
    "protocolNumber": "(val)",
    "applicationDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "comments": "(val)",
    "protocolStatus": "(val)",
    "sequenceOwner.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalSpecialReviewId": "(val)",
    "specialReviewNumber": "(val)",
    "specialReviewTypeCode": "(val)",
    "approvalTypeCode": "(val)",
    "protocolNumber": "(val)",
    "applicationDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "comments": "(val)",
    "protocolStatus": "(val)",
    "sequenceOwner.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Special Reviews
GET/instprop/api/v1/institutional-proposal-special-reviews/

Example URI

GET /instprop/api/v1/institutional-proposal-special-reviews/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalSpecialReviewId",
    "specialReviewNumber",
    "specialReviewTypeCode",
    "approvalTypeCode",
    "protocolNumber",
    "applicationDate",
    "approvalDate",
    "expirationDate",
    "comments",
    "protocolStatus",
    "sequenceOwner.proposalId"
  ],
  "primaryKey": "proposalSpecialReviewId"
}

Get Blueprint API specification for Institutional Proposal Special Reviews
GET/instprop/api/v1/institutional-proposal-special-reviews/

Example URI

GET /instprop/api/v1/institutional-proposal-special-reviews/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Special Reviews.md"
transfer-encoding: chunked

Update Institutional Proposal Special Reviews
PUT/instprop/api/v1/institutional-proposal-special-reviews/(key)

Example URI

PUT /instprop/api/v1/institutional-proposal-special-reviews/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalSpecialReviewId": "(val)",
  "specialReviewNumber": "(val)",
  "specialReviewTypeCode": "(val)",
  "approvalTypeCode": "(val)",
  "protocolNumber": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "expirationDate": "(val)",
  "comments": "(val)",
  "protocolStatus": "(val)",
  "sequenceOwner.proposalId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Institutional Proposal Special Reviews
PUT/instprop/api/v1/institutional-proposal-special-reviews/

Example URI

PUT /instprop/api/v1/institutional-proposal-special-reviews/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalSpecialReviewId": "(val)",
    "specialReviewNumber": "(val)",
    "specialReviewTypeCode": "(val)",
    "approvalTypeCode": "(val)",
    "protocolNumber": "(val)",
    "applicationDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "comments": "(val)",
    "protocolStatus": "(val)",
    "sequenceOwner.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalSpecialReviewId": "(val)",
    "specialReviewNumber": "(val)",
    "specialReviewTypeCode": "(val)",
    "approvalTypeCode": "(val)",
    "protocolNumber": "(val)",
    "applicationDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "comments": "(val)",
    "protocolStatus": "(val)",
    "sequenceOwner.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Institutional Proposal Special Reviews
PATCH/instprop/api/v1/institutional-proposal-special-reviews/(key)

Example URI

PATCH /instprop/api/v1/institutional-proposal-special-reviews/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalSpecialReviewId": "(val)",
  "specialReviewNumber": "(val)",
  "specialReviewTypeCode": "(val)",
  "approvalTypeCode": "(val)",
  "protocolNumber": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "expirationDate": "(val)",
  "comments": "(val)",
  "protocolStatus": "(val)",
  "sequenceOwner.proposalId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "proposalSpecialReviewId": "(val)",
  "specialReviewNumber": "(val)",
  "specialReviewTypeCode": "(val)",
  "approvalTypeCode": "(val)",
  "protocolNumber": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "expirationDate": "(val)",
  "comments": "(val)",
  "protocolStatus": "(val)",
  "sequenceOwner.proposalId": "(val)",
  "_primaryKey": "(val)"
}

Institutional Proposal Unit Contacts

Get Institutional Proposal Unit Contacts by Key
GET/instprop/api/v1/institutional-proposal-unit-contacts/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-unit-contacts/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "institutionalProposalContactId": "(val)",
  "personId": "(val)",
  "fullName": "(val)",
  "unitContactType": "(val)",
  "unitAdministratorTypeCode": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "institutionalProposal.proposalId": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Unit Contacts
GET/instprop/api/v1/institutional-proposal-unit-contacts/

Example URI

GET /instprop/api/v1/institutional-proposal-unit-contacts/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "institutionalProposalContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Unit Contacts with Filtering
GET/instprop/api/v1/institutional-proposal-unit-contacts/

Example URI

GET /instprop/api/v1/institutional-proposal-unit-contacts/
URI Parameters
HideShow
institutionalProposalContactId
string (optional) 
personId
string (optional) 
fullName
string (optional) 
unitContactType
string (optional) 
unitAdministratorTypeCode
string (optional) 

Project Role. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

proposalNumber
string (optional) 
sequenceNumber
string (optional) 
institutionalProposal.proposalId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "institutionalProposalContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "institutionalProposalContactId": "(val)",
    "personId": "(val)",
    "fullName": "(val)",
    "unitContactType": "(val)",
    "unitAdministratorTypeCode": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Unit Contacts
GET/instprop/api/v1/institutional-proposal-unit-contacts/

Example URI

GET /instprop/api/v1/institutional-proposal-unit-contacts/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "institutionalProposalContactId",
    "personId",
    "fullName",
    "unitContactType",
    "unitAdministratorTypeCode",
    "proposalNumber",
    "sequenceNumber",
    "institutionalProposal.proposalId"
  ],
  "primaryKey": "institutionalProposalContactId"
}

Get Blueprint API specification for Institutional Proposal Unit Contacts
GET/instprop/api/v1/institutional-proposal-unit-contacts/

Example URI

GET /instprop/api/v1/institutional-proposal-unit-contacts/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Unit Contacts.md"
transfer-encoding: chunked

Institutional Proposal Unrecovered F And As

Get Institutional Proposal Unrecovered F And As by Key
GET/instprop/api/v1/institutional-proposal-unrecovered-f-and-as/(key)

Example URI

GET /instprop/api/v1/institutional-proposal-unrecovered-f-and-as/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalUnrecoveredFandAId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "applicableIndirectcostRate": "(val)",
  "indirectcostRateTypeCode": "(val)",
  "fiscalYear": "(val)",
  "onCampusFlag": "(val)",
  "underrecoveryOfIndirectcost": "(val)",
  "sourceAccount": "(val)",
  "institutionalProposal.proposalId": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposal Unrecovered F And As
GET/instprop/api/v1/institutional-proposal-unrecovered-f-and-as/

Example URI

GET /instprop/api/v1/institutional-proposal-unrecovered-f-and-as/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalUnrecoveredFandAId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "applicableIndirectcostRate": "(val)",
    "indirectcostRateTypeCode": "(val)",
    "fiscalYear": "(val)",
    "onCampusFlag": "(val)",
    "underrecoveryOfIndirectcost": "(val)",
    "sourceAccount": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalUnrecoveredFandAId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "applicableIndirectcostRate": "(val)",
    "indirectcostRateTypeCode": "(val)",
    "fiscalYear": "(val)",
    "onCampusFlag": "(val)",
    "underrecoveryOfIndirectcost": "(val)",
    "sourceAccount": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposal Unrecovered F And As with Filtering
GET/instprop/api/v1/institutional-proposal-unrecovered-f-and-as/

Example URI

GET /instprop/api/v1/institutional-proposal-unrecovered-f-and-as/
URI Parameters
HideShow
proposalUnrecoveredFandAId
string (optional) 

Proposal Unrecovered FNA Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

proposalNumber
string (optional) 

Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.

applicableIndirectcostRate
string (optional) 

Applicable Indirectcost Rate. Maximum length is 10. Validating pattern is ^([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.

indirectcostRateTypeCode
string (optional) 

IDC Rate Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.

fiscalYear
string (optional) 

Fiscal Year. Maximum length is 4. Validating pattern is ^[A-Za-z0-9]*$.

onCampusFlag
string (optional) 

On CampusContractContract Flag. Maximum length is 1. Validating pattern is ^[\p{Graph}]*$.

underrecoveryOfIndirectcost
string (optional) 

Underrecovery of Indirect Cost. Maximum length is 22. Validating pattern is ^([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.

sourceAccount
string (optional) 

Source Account. Maximum length is 32. Validating pattern is ^[\p{Graph}\p{Space}]*$.

institutionalProposal.proposalId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalUnrecoveredFandAId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "applicableIndirectcostRate": "(val)",
    "indirectcostRateTypeCode": "(val)",
    "fiscalYear": "(val)",
    "onCampusFlag": "(val)",
    "underrecoveryOfIndirectcost": "(val)",
    "sourceAccount": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalUnrecoveredFandAId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "applicableIndirectcostRate": "(val)",
    "indirectcostRateTypeCode": "(val)",
    "fiscalYear": "(val)",
    "onCampusFlag": "(val)",
    "underrecoveryOfIndirectcost": "(val)",
    "sourceAccount": "(val)",
    "institutionalProposal.proposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposal Unrecovered F And As
GET/instprop/api/v1/institutional-proposal-unrecovered-f-and-as/

Example URI

GET /instprop/api/v1/institutional-proposal-unrecovered-f-and-as/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalUnrecoveredFandAId",
    "proposalNumber",
    "sequenceNumber",
    "applicableIndirectcostRate",
    "indirectcostRateTypeCode",
    "fiscalYear",
    "onCampusFlag",
    "underrecoveryOfIndirectcost",
    "sourceAccount",
    "institutionalProposal.proposalId"
  ],
  "primaryKey": "proposalUnrecoveredFandAId"
}

Get Blueprint API specification for Institutional Proposal Unrecovered F And As
GET/instprop/api/v1/institutional-proposal-unrecovered-f-and-as/

Example URI

GET /instprop/api/v1/institutional-proposal-unrecovered-f-and-as/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposal Unrecovered F And As.md"
transfer-encoding: chunked

Institutional Proposals

Get Institutional Proposals by Key
GET/instprop/api/v1/institutional-proposals/(key)

Example URI

GET /instprop/api/v1/institutional-proposals/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "primeSponsorCode": "(val)",
  "initialContractAdmin": "(val)",
  "ipReviewActivityIndicator": "(val)",
  "currentAwardNumber": "(val)",
  "opportunity": "(val)",
  "proposalSequenceStatus": "(val)",
  "createTimestamp": "(val)",
  "awardTypeCode": "(val)",
  "unitNumber": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sponsorProposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "proposalTypeCode": "(val)",
  "currentAccountNumber": "(val)",
  "title": "(val)",
  "sponsorCode": "(val)",
  "rolodexId": "(val)",
  "noticeOfOpportunityCode": "(val)",
  "gradStudHeadcount": "(val)",
  "gradStudPersonMonths": "(val)",
  "typeOfAccount": "(val)",
  "activityTypeCode": "(val)",
  "requestedStartDateInitial": "(val)",
  "requestedStartDateTotal": "(val)",
  "requestedEndDateInitial": "(val)",
  "requestedEndDateTotal": "(val)",
  "fiscalMonth": "(val)",
  "fiscalYear": "(val)",
  "totalDirectCostInitial": "(val)",
  "totalDirectCostTotal": "(val)",
  "totalIndirectCostInitial": "(val)",
  "totalIndirectCostTotal": "(val)",
  "numberOfCopies": "(val)",
  "deadlineDate": "(val)",
  "deadlineTime": "(val)",
  "deadlineType": "(val)",
  "mailBy": "(val)",
  "mailType": "(val)",
  "mailAccountNumber": "(val)",
  "mailDescription": "(val)",
  "subcontractFlag": "(val)",
  "costSharingIndicator": "(val)",
  "idcRateIndicator": "(val)",
  "specialReviewIndicator": "(val)",
  "statusCode": "(val)",
  "scienceCodeIndicator": "(val)",
  "nsfSequenceNumber": "(val)",
  "institutionalProposalDocument.documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Institutional Proposals
GET/instprop/api/v1/institutional-proposals/

Example URI

GET /instprop/api/v1/institutional-proposals/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "primeSponsorCode": "(val)",
    "initialContractAdmin": "(val)",
    "ipReviewActivityIndicator": "(val)",
    "currentAwardNumber": "(val)",
    "opportunity": "(val)",
    "proposalSequenceStatus": "(val)",
    "createTimestamp": "(val)",
    "awardTypeCode": "(val)",
    "unitNumber": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sponsorProposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "proposalTypeCode": "(val)",
    "currentAccountNumber": "(val)",
    "title": "(val)",
    "sponsorCode": "(val)",
    "rolodexId": "(val)",
    "noticeOfOpportunityCode": "(val)",
    "gradStudHeadcount": "(val)",
    "gradStudPersonMonths": "(val)",
    "typeOfAccount": "(val)",
    "activityTypeCode": "(val)",
    "requestedStartDateInitial": "(val)",
    "requestedStartDateTotal": "(val)",
    "requestedEndDateInitial": "(val)",
    "requestedEndDateTotal": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "totalDirectCostInitial": "(val)",
    "totalDirectCostTotal": "(val)",
    "totalIndirectCostInitial": "(val)",
    "totalIndirectCostTotal": "(val)",
    "numberOfCopies": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "deadlineType": "(val)",
    "mailBy": "(val)",
    "mailType": "(val)",
    "mailAccountNumber": "(val)",
    "mailDescription": "(val)",
    "subcontractFlag": "(val)",
    "costSharingIndicator": "(val)",
    "idcRateIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "statusCode": "(val)",
    "scienceCodeIndicator": "(val)",
    "nsfSequenceNumber": "(val)",
    "institutionalProposalDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "primeSponsorCode": "(val)",
    "initialContractAdmin": "(val)",
    "ipReviewActivityIndicator": "(val)",
    "currentAwardNumber": "(val)",
    "opportunity": "(val)",
    "proposalSequenceStatus": "(val)",
    "createTimestamp": "(val)",
    "awardTypeCode": "(val)",
    "unitNumber": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sponsorProposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "proposalTypeCode": "(val)",
    "currentAccountNumber": "(val)",
    "title": "(val)",
    "sponsorCode": "(val)",
    "rolodexId": "(val)",
    "noticeOfOpportunityCode": "(val)",
    "gradStudHeadcount": "(val)",
    "gradStudPersonMonths": "(val)",
    "typeOfAccount": "(val)",
    "activityTypeCode": "(val)",
    "requestedStartDateInitial": "(val)",
    "requestedStartDateTotal": "(val)",
    "requestedEndDateInitial": "(val)",
    "requestedEndDateTotal": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "totalDirectCostInitial": "(val)",
    "totalDirectCostTotal": "(val)",
    "totalIndirectCostInitial": "(val)",
    "totalIndirectCostTotal": "(val)",
    "numberOfCopies": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "deadlineType": "(val)",
    "mailBy": "(val)",
    "mailType": "(val)",
    "mailAccountNumber": "(val)",
    "mailDescription": "(val)",
    "subcontractFlag": "(val)",
    "costSharingIndicator": "(val)",
    "idcRateIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "statusCode": "(val)",
    "scienceCodeIndicator": "(val)",
    "nsfSequenceNumber": "(val)",
    "institutionalProposalDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Institutional Proposals with Filtering
GET/instprop/api/v1/institutional-proposals/

Example URI

GET /instprop/api/v1/institutional-proposals/
URI Parameters
HideShow
primeSponsorCode
string (optional) 

Prime Sponsor Code. Maximum length is 20. Validating pattern is ^[A-Za-z0-9]*$.

initialContractAdmin
string (optional) 

Initial Contract Admin. Maximum length is 30. Validating pattern is ^[\p{Graph}\p{Space}]*$.

ipReviewActivityIndicator
string (optional) 

Ip Review Activity Indicator. Maximum length is 2. Validating pattern is ^[A-Za-z0-9\s]*$.

currentAwardNumber
string (optional) 

Current Award Number. Maximum length is 12. Validating pattern is ^[\p{Graph}]*$.

opportunity
string (optional) 

Opportunity. Maximum length is 50. Validating pattern is ^[\u0000-\uFFFF]*$.

proposalSequenceStatus
string (optional) 
createTimestamp
string (optional) 

Proposal Create Date. Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

awardTypeCode
string (optional) 

Award Type Code. Maximum length is 15. Validating pattern is ^[\p{Graph}]*$.

unitNumber
string (optional) 
proposalId
string (optional) 

Institutional Proposal ID. Maximum length is 22. Validating pattern is ^[0-9]*$.

proposalNumber
string (optional) 

Institutional Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

sponsorProposalNumber
string (optional) 

Sponsor Proposal ID. Maximum length is 70. Validating pattern is ^[\p{Graph}\p{Space}]*$.

sequenceNumber
string (optional) 

Institutional Proposal Version. Maximum length is 22. Validating pattern is ^[0-9]*$.

proposalTypeCode
string (optional) 

Proposal Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.

currentAccountNumber
string (optional) 

Current Account Number. Maximum length is 7. Validating pattern is ^[A-Za-z0-9]*$.

title
string (optional) 

Title. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

sponsorCode
string (optional) 

Sponsor ID. Maximum length is 20. Validating pattern is ^[A-Za-z0-9]*$.

rolodexId
string (optional) 

Rolodex ID. Maximum length is 22. Validating pattern is ^((-?[1-9][0-9])|[0])*$.

noticeOfOpportunityCode
string (optional) 

Notice Of Opportunity Code. Maximum length is 3. Validating pattern is ^[\p{Graph}]*$.

gradStudHeadcount
string (optional) 

Grad Stud Headcount. Maximum length is 3. Validating pattern is ^[0-9]*$.

gradStudPersonMonths
string (optional) 

Grad Stud Person Months. Maximum length is 6. Validating pattern is ^-?([0-9]{0,3}.[0-9]{1,2}|[0-9]{1,3})$.

typeOfAccount
string (optional) 

Type Of Account. Maximum length is 1. Validating pattern is .*.

activityTypeCode
string (optional) 

Activity Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.

requestedStartDateInitial
string (optional) 

Requested Start Date Initial. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

requestedStartDateTotal
string (optional) 

Requested Start Date Total. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

requestedEndDateInitial
string (optional) 

Requested End Date Initial. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

requestedEndDateTotal
string (optional) 

Requested End Date Total. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

fiscalMonth
string (optional) 

Fiscal Month. Maximum length is 2. Validating pattern is ^[0-9]*$.

fiscalYear
string (optional) 

Fiscal Year. Maximum length is 4. Validating pattern is ^[0-9]*$.

totalDirectCostInitial
string (optional) 

Total Direct Cost Initial. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.

totalDirectCostTotal
string (optional) 

Total Direct Cost Total. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.

totalIndirectCostInitial
string (optional) 

Total Indirect Cost Initial. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.

totalIndirectCostTotal
string (optional) 

Total Indirect Cost Total. Maximum length is 22. Validating pattern is ^-?([0-9]{0,10}.[0-9]{1,2}|[0-9]{1,10})$.

numberOfCopies
string (optional) 

The number of paper copies of the proposal that should be mailed to the agency/sponsor. Maximum length is 2. Validating pattern is ^[0-9]*$.

deadlineDate
string (optional) 

The date in which the proposal is due to the sponsoring agency. Additional deadlines may be set by the office authorized to submit proposals on behalf of the institution (e.g. sponsored programs, etc.). Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

deadlineTime
string (optional) 

The time in which the proposal is due to the sponsoring agency. Additional deadlines may be set by the office authorized to submit proposals on behalf of the institution (e.g. sponsored programs, etc.). Maximum length is 15. Validating pattern is .*.

deadlineType
string (optional) 

Indicates the type of proposal deadline. Maximum length is 3. Validating pattern is ^[\p{Graph}]*$.

mailBy
string (optional) 

This field determines whether the Sponsored Programs Office or the department will be mailing the proposal to the agency/sponsor. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

mailType
string (optional) 

The method by which the proposal will be delivered to the agency/sponsor. Maximum length is 1. Validating pattern is ^[\p{Graph}]*$.

mailAccountNumber
string (optional) 

The internal school account number that should be charged the mailing costs. Maximum length is 7. Validating pattern is ^[\p{Graph}\p{Space}]*$.

mailDescription
string (optional) 

Any information that will assist in the delivery of the proposal. Maximum length is 1000. Validating pattern is ^[\p{Graph}\p{Space}]*$.

subcontractFlag
string (optional) 

Subcontract Flag. Maximum length is 3. Validating pattern is ^[\p{Graph}]*$.

costSharingIndicator
string (optional) 

This attribute should always be overriden on the descriptive elements. Maximum length is 1. Validating pattern is .*.

idcRateIndicator
string (optional) 

This attribute should always be overriden on the descriptive elements. Maximum length is 1. Validating pattern is .*.

specialReviewIndicator
string (optional) 

This attribute should always be overriden on the descriptive elements. Maximum length is 1. Validating pattern is .*.

statusCode
string (optional) 

Status Code. Maximum length is 3. Validating pattern is ^[0-9]*$.

scienceCodeIndicator
string (optional) 
nsfSequenceNumber
string (optional) 

NSF Science Code. Maximum length is 12. Validating pattern is ^[0-9]*$.

institutionalProposalDocument.documentNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "primeSponsorCode": "(val)",
    "initialContractAdmin": "(val)",
    "ipReviewActivityIndicator": "(val)",
    "currentAwardNumber": "(val)",
    "opportunity": "(val)",
    "proposalSequenceStatus": "(val)",
    "createTimestamp": "(val)",
    "awardTypeCode": "(val)",
    "unitNumber": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sponsorProposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "proposalTypeCode": "(val)",
    "currentAccountNumber": "(val)",
    "title": "(val)",
    "sponsorCode": "(val)",
    "rolodexId": "(val)",
    "noticeOfOpportunityCode": "(val)",
    "gradStudHeadcount": "(val)",
    "gradStudPersonMonths": "(val)",
    "typeOfAccount": "(val)",
    "activityTypeCode": "(val)",
    "requestedStartDateInitial": "(val)",
    "requestedStartDateTotal": "(val)",
    "requestedEndDateInitial": "(val)",
    "requestedEndDateTotal": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "totalDirectCostInitial": "(val)",
    "totalDirectCostTotal": "(val)",
    "totalIndirectCostInitial": "(val)",
    "totalIndirectCostTotal": "(val)",
    "numberOfCopies": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "deadlineType": "(val)",
    "mailBy": "(val)",
    "mailType": "(val)",
    "mailAccountNumber": "(val)",
    "mailDescription": "(val)",
    "subcontractFlag": "(val)",
    "costSharingIndicator": "(val)",
    "idcRateIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "statusCode": "(val)",
    "scienceCodeIndicator": "(val)",
    "nsfSequenceNumber": "(val)",
    "institutionalProposalDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "primeSponsorCode": "(val)",
    "initialContractAdmin": "(val)",
    "ipReviewActivityIndicator": "(val)",
    "currentAwardNumber": "(val)",
    "opportunity": "(val)",
    "proposalSequenceStatus": "(val)",
    "createTimestamp": "(val)",
    "awardTypeCode": "(val)",
    "unitNumber": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sponsorProposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "proposalTypeCode": "(val)",
    "currentAccountNumber": "(val)",
    "title": "(val)",
    "sponsorCode": "(val)",
    "rolodexId": "(val)",
    "noticeOfOpportunityCode": "(val)",
    "gradStudHeadcount": "(val)",
    "gradStudPersonMonths": "(val)",
    "typeOfAccount": "(val)",
    "activityTypeCode": "(val)",
    "requestedStartDateInitial": "(val)",
    "requestedStartDateTotal": "(val)",
    "requestedEndDateInitial": "(val)",
    "requestedEndDateTotal": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "totalDirectCostInitial": "(val)",
    "totalDirectCostTotal": "(val)",
    "totalIndirectCostInitial": "(val)",
    "totalIndirectCostTotal": "(val)",
    "numberOfCopies": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "deadlineType": "(val)",
    "mailBy": "(val)",
    "mailType": "(val)",
    "mailAccountNumber": "(val)",
    "mailDescription": "(val)",
    "subcontractFlag": "(val)",
    "costSharingIndicator": "(val)",
    "idcRateIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "statusCode": "(val)",
    "scienceCodeIndicator": "(val)",
    "nsfSequenceNumber": "(val)",
    "institutionalProposalDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Institutional Proposals
GET/instprop/api/v1/institutional-proposals/

Example URI

GET /instprop/api/v1/institutional-proposals/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "primeSponsorCode",
    "initialContractAdmin",
    "ipReviewActivityIndicator",
    "currentAwardNumber",
    "opportunity",
    "proposalSequenceStatus",
    "createTimestamp",
    "awardTypeCode",
    "unitNumber",
    "proposalId",
    "proposalNumber",
    "sponsorProposalNumber",
    "sequenceNumber",
    "proposalTypeCode",
    "currentAccountNumber",
    "title",
    "sponsorCode",
    "rolodexId",
    "noticeOfOpportunityCode",
    "gradStudHeadcount",
    "gradStudPersonMonths",
    "typeOfAccount",
    "activityTypeCode",
    "requestedStartDateInitial",
    "requestedStartDateTotal",
    "requestedEndDateInitial",
    "requestedEndDateTotal",
    "fiscalMonth",
    "fiscalYear",
    "totalDirectCostInitial",
    "totalDirectCostTotal",
    "totalIndirectCostInitial",
    "totalIndirectCostTotal",
    "numberOfCopies",
    "deadlineDate",
    "deadlineTime",
    "deadlineType",
    "mailBy",
    "mailType",
    "mailAccountNumber",
    "mailDescription",
    "subcontractFlag",
    "costSharingIndicator",
    "idcRateIndicator",
    "specialReviewIndicator",
    "statusCode",
    "scienceCodeIndicator",
    "nsfSequenceNumber",
    "institutionalProposalDocument.documentNumber"
  ],
  "primaryKey": "proposalId"
}

Get Blueprint API specification for Institutional Proposals
GET/instprop/api/v1/institutional-proposals/

Example URI

GET /instprop/api/v1/institutional-proposals/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institutional Proposals.md"
transfer-encoding: chunked

Update Institutional Proposals
PUT/instprop/api/v1/institutional-proposals/(key)

Example URI

PUT /instprop/api/v1/institutional-proposals/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "primeSponsorCode": "(val)",
  "initialContractAdmin": "(val)",
  "ipReviewActivityIndicator": "(val)",
  "currentAwardNumber": "(val)",
  "opportunity": "(val)",
  "proposalSequenceStatus": "(val)",
  "createTimestamp": "(val)",
  "awardTypeCode": "(val)",
  "unitNumber": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sponsorProposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "proposalTypeCode": "(val)",
  "currentAccountNumber": "(val)",
  "title": "(val)",
  "sponsorCode": "(val)",
  "rolodexId": "(val)",
  "noticeOfOpportunityCode": "(val)",
  "gradStudHeadcount": "(val)",
  "gradStudPersonMonths": "(val)",
  "typeOfAccount": "(val)",
  "activityTypeCode": "(val)",
  "requestedStartDateInitial": "(val)",
  "requestedStartDateTotal": "(val)",
  "requestedEndDateInitial": "(val)",
  "requestedEndDateTotal": "(val)",
  "fiscalMonth": "(val)",
  "fiscalYear": "(val)",
  "totalDirectCostInitial": "(val)",
  "totalDirectCostTotal": "(val)",
  "totalIndirectCostInitial": "(val)",
  "totalIndirectCostTotal": "(val)",
  "numberOfCopies": "(val)",
  "deadlineDate": "(val)",
  "deadlineTime": "(val)",
  "deadlineType": "(val)",
  "mailBy": "(val)",
  "mailType": "(val)",
  "mailAccountNumber": "(val)",
  "mailDescription": "(val)",
  "subcontractFlag": "(val)",
  "costSharingIndicator": "(val)",
  "idcRateIndicator": "(val)",
  "specialReviewIndicator": "(val)",
  "statusCode": "(val)",
  "scienceCodeIndicator": "(val)",
  "nsfSequenceNumber": "(val)",
  "institutionalProposalDocument.documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Institutional Proposals
PUT/instprop/api/v1/institutional-proposals/

Example URI

PUT /instprop/api/v1/institutional-proposals/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "primeSponsorCode": "(val)",
    "initialContractAdmin": "(val)",
    "ipReviewActivityIndicator": "(val)",
    "currentAwardNumber": "(val)",
    "opportunity": "(val)",
    "proposalSequenceStatus": "(val)",
    "createTimestamp": "(val)",
    "awardTypeCode": "(val)",
    "unitNumber": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sponsorProposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "proposalTypeCode": "(val)",
    "currentAccountNumber": "(val)",
    "title": "(val)",
    "sponsorCode": "(val)",
    "rolodexId": "(val)",
    "noticeOfOpportunityCode": "(val)",
    "gradStudHeadcount": "(val)",
    "gradStudPersonMonths": "(val)",
    "typeOfAccount": "(val)",
    "activityTypeCode": "(val)",
    "requestedStartDateInitial": "(val)",
    "requestedStartDateTotal": "(val)",
    "requestedEndDateInitial": "(val)",
    "requestedEndDateTotal": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "totalDirectCostInitial": "(val)",
    "totalDirectCostTotal": "(val)",
    "totalIndirectCostInitial": "(val)",
    "totalIndirectCostTotal": "(val)",
    "numberOfCopies": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "deadlineType": "(val)",
    "mailBy": "(val)",
    "mailType": "(val)",
    "mailAccountNumber": "(val)",
    "mailDescription": "(val)",
    "subcontractFlag": "(val)",
    "costSharingIndicator": "(val)",
    "idcRateIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "statusCode": "(val)",
    "scienceCodeIndicator": "(val)",
    "nsfSequenceNumber": "(val)",
    "institutionalProposalDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "primeSponsorCode": "(val)",
    "initialContractAdmin": "(val)",
    "ipReviewActivityIndicator": "(val)",
    "currentAwardNumber": "(val)",
    "opportunity": "(val)",
    "proposalSequenceStatus": "(val)",
    "createTimestamp": "(val)",
    "awardTypeCode": "(val)",
    "unitNumber": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sponsorProposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "proposalTypeCode": "(val)",
    "currentAccountNumber": "(val)",
    "title": "(val)",
    "sponsorCode": "(val)",
    "rolodexId": "(val)",
    "noticeOfOpportunityCode": "(val)",
    "gradStudHeadcount": "(val)",
    "gradStudPersonMonths": "(val)",
    "typeOfAccount": "(val)",
    "activityTypeCode": "(val)",
    "requestedStartDateInitial": "(val)",
    "requestedStartDateTotal": "(val)",
    "requestedEndDateInitial": "(val)",
    "requestedEndDateTotal": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "totalDirectCostInitial": "(val)",
    "totalDirectCostTotal": "(val)",
    "totalIndirectCostInitial": "(val)",
    "totalIndirectCostTotal": "(val)",
    "numberOfCopies": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "deadlineType": "(val)",
    "mailBy": "(val)",
    "mailType": "(val)",
    "mailAccountNumber": "(val)",
    "mailDescription": "(val)",
    "subcontractFlag": "(val)",
    "costSharingIndicator": "(val)",
    "idcRateIndicator": "(val)",
    "specialReviewIndicator": "(val)",
    "statusCode": "(val)",
    "scienceCodeIndicator": "(val)",
    "nsfSequenceNumber": "(val)",
    "institutionalProposalDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Institutional Proposals
PATCH/instprop/api/v1/institutional-proposals/(key)

Example URI

PATCH /instprop/api/v1/institutional-proposals/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "primeSponsorCode": "(val)",
  "initialContractAdmin": "(val)",
  "ipReviewActivityIndicator": "(val)",
  "currentAwardNumber": "(val)",
  "opportunity": "(val)",
  "proposalSequenceStatus": "(val)",
  "createTimestamp": "(val)",
  "awardTypeCode": "(val)",
  "unitNumber": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sponsorProposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "proposalTypeCode": "(val)",
  "currentAccountNumber": "(val)",
  "title": "(val)",
  "sponsorCode": "(val)",
  "rolodexId": "(val)",
  "noticeOfOpportunityCode": "(val)",
  "gradStudHeadcount": "(val)",
  "gradStudPersonMonths": "(val)",
  "typeOfAccount": "(val)",
  "activityTypeCode": "(val)",
  "requestedStartDateInitial": "(val)",
  "requestedStartDateTotal": "(val)",
  "requestedEndDateInitial": "(val)",
  "requestedEndDateTotal": "(val)",
  "fiscalMonth": "(val)",
  "fiscalYear": "(val)",
  "totalDirectCostInitial": "(val)",
  "totalDirectCostTotal": "(val)",
  "totalIndirectCostInitial": "(val)",
  "totalIndirectCostTotal": "(val)",
  "numberOfCopies": "(val)",
  "deadlineDate": "(val)",
  "deadlineTime": "(val)",
  "deadlineType": "(val)",
  "mailBy": "(val)",
  "mailType": "(val)",
  "mailAccountNumber": "(val)",
  "mailDescription": "(val)",
  "subcontractFlag": "(val)",
  "costSharingIndicator": "(val)",
  "idcRateIndicator": "(val)",
  "specialReviewIndicator": "(val)",
  "statusCode": "(val)",
  "scienceCodeIndicator": "(val)",
  "nsfSequenceNumber": "(val)",
  "institutionalProposalDocument.documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "primeSponsorCode": "(val)",
  "initialContractAdmin": "(val)",
  "ipReviewActivityIndicator": "(val)",
  "currentAwardNumber": "(val)",
  "opportunity": "(val)",
  "proposalSequenceStatus": "(val)",
  "createTimestamp": "(val)",
  "awardTypeCode": "(val)",
  "unitNumber": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sponsorProposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "proposalTypeCode": "(val)",
  "currentAccountNumber": "(val)",
  "title": "(val)",
  "sponsorCode": "(val)",
  "rolodexId": "(val)",
  "noticeOfOpportunityCode": "(val)",
  "gradStudHeadcount": "(val)",
  "gradStudPersonMonths": "(val)",
  "typeOfAccount": "(val)",
  "activityTypeCode": "(val)",
  "requestedStartDateInitial": "(val)",
  "requestedStartDateTotal": "(val)",
  "requestedEndDateInitial": "(val)",
  "requestedEndDateTotal": "(val)",
  "fiscalMonth": "(val)",
  "fiscalYear": "(val)",
  "totalDirectCostInitial": "(val)",
  "totalDirectCostTotal": "(val)",
  "totalIndirectCostInitial": "(val)",
  "totalIndirectCostTotal": "(val)",
  "numberOfCopies": "(val)",
  "deadlineDate": "(val)",
  "deadlineTime": "(val)",
  "deadlineType": "(val)",
  "mailBy": "(val)",
  "mailType": "(val)",
  "mailAccountNumber": "(val)",
  "mailDescription": "(val)",
  "subcontractFlag": "(val)",
  "costSharingIndicator": "(val)",
  "idcRateIndicator": "(val)",
  "specialReviewIndicator": "(val)",
  "statusCode": "(val)",
  "scienceCodeIndicator": "(val)",
  "nsfSequenceNumber": "(val)",
  "institutionalProposalDocument.documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Institutional Proposal

Proposal Summary
GET/instprop/api/v1/institutional-proposals/?summary

Summary of all Institutional Proposals in the system

Example URI

GET /instprop/api/v1/institutional-proposals/?summary
URI Parameters
HideShow
summary
boolean (required) 

Renders the proposals in a summary view instead of the full data from the proposal. Currently the only option and required.

updatedSince
date (optional) Example: 1452126023000

Criteria to restrict the proposals returned to those updated since the date specified. Formatted as milliseconds since epoch.

limit
number (optional) Example: 50

Number of results to return. If not included, all proposals matching the date,if specified, are returned.

page
number (optional) Example: 8

If a numberPerPage is specified this determines what page of the result set will be returned on this request.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
   "totalFound" : 598,
   "count" : 1,
   "institutionalProposals" : [
      {
           "proposalId": 10,
         "proposalNumber" : "80070",
         "sequenceNumber": 1
         "proposalLogProposalNumber": "00000009",
          "leadUnit": {
            "unitNumber": "000001",
            "unitName": "University",
            "parentUnitNumber": null,
            "organizationId": "000001"
          },
         "fundingProposals" : [
            {
              "proposalSequenceNumber": 1,
              "awardNumber": "999901-00001",
              "awardSequenceNumber": 1,
              "awardId": 2238,
              "proposalId": 1,
              "proposalNumber": "80070"
            },
            {
              "proposalSequenceNumber": 1,
              "awardNumber": "999901-00002",
              "awardSequenceNumber": 1,
              "awardId": 2251,
              "proposalId": 1,
              "proposalNumber": "80070"
            },
            {
              "proposalSequenceNumber": 1,
              "awardNumber": "999901-00003",
              "awardSequenceNumber": 1,
              "awardId": 2264,
              "proposalId": 1,
              "proposalNumber": "80070"
            }
         ],
         "principalInvestigator" : {
            "fullName" : "Inez  Chew",
            "personId" : "10000000005",
            "roleCode" : "PI",
            "projectRole" : "Principal Investigator",
            "userName" : "chew",
            "emailAddress" : "kcnotification@gmail.com"
         },
         "sponsor" : {
            "sponsorCode" : "055075",
            "acronym" : null,
            "sponsorName" : "Kuali LOC Testing"
         }
      },
   ]
}

Intellectual Property Review Activities

Get Intellectual Property Review Activities by Key
GET/instprop/api/v1/intellectual-property-review-activities/(key)

Example URI

GET /instprop/api/v1/intellectual-property-review-activities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "ipReviewActivityTypeCode": "(val)",
  "activityDate": "(val)",
  "comments": "(val)",
  "proposalIpReviewActivityId": "(val)",
  "ipReviewId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "activityNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Intellectual Property Review Activities
GET/instprop/api/v1/intellectual-property-review-activities/

Example URI

GET /instprop/api/v1/intellectual-property-review-activities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "ipReviewActivityTypeCode": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "proposalIpReviewActivityId": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "activityNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ipReviewActivityTypeCode": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "proposalIpReviewActivityId": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "activityNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Intellectual Property Review Activities with Filtering
GET/instprop/api/v1/intellectual-property-review-activities/

Example URI

GET /instprop/api/v1/intellectual-property-review-activities/
URI Parameters
HideShow
ipReviewActivityTypeCode
string (optional) 

IP Review Activity Type Code. Maximum length is 22. Validating pattern is ^[0-9]*$.

activityDate
string (optional) 

Activity Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

comments
string (optional) 

Comments. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.

proposalIpReviewActivityId
string (optional) 

Proposal Ip Rev Activity Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

ipReviewId
string (optional) 
proposalNumber
string (optional) 

Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.

activityNumber
string (optional) 

Activity Number. Maximum length is 3. Validating pattern is ^[0-9]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "ipReviewActivityTypeCode": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "proposalIpReviewActivityId": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "activityNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ipReviewActivityTypeCode": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "proposalIpReviewActivityId": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "activityNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Intellectual Property Review Activities
GET/instprop/api/v1/intellectual-property-review-activities/

Example URI

GET /instprop/api/v1/intellectual-property-review-activities/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "ipReviewActivityTypeCode",
    "activityDate",
    "comments",
    "proposalIpReviewActivityId",
    "ipReviewId",
    "proposalNumber",
    "sequenceNumber",
    "activityNumber"
  ],
  "primaryKey": "proposalIpReviewActivityId"
}

Get Blueprint API specification for Intellectual Property Review Activities
GET/instprop/api/v1/intellectual-property-review-activities/

Example URI

GET /instprop/api/v1/intellectual-property-review-activities/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Intellectual Property Review Activities.md"
transfer-encoding: chunked

Update Intellectual Property Review Activities
PUT/instprop/api/v1/intellectual-property-review-activities/(key)

Example URI

PUT /instprop/api/v1/intellectual-property-review-activities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ipReviewActivityTypeCode": "(val)",
  "activityDate": "(val)",
  "comments": "(val)",
  "proposalIpReviewActivityId": "(val)",
  "ipReviewId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "activityNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Intellectual Property Review Activities
PUT/instprop/api/v1/intellectual-property-review-activities/

Example URI

PUT /instprop/api/v1/intellectual-property-review-activities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "ipReviewActivityTypeCode": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "proposalIpReviewActivityId": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "activityNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ipReviewActivityTypeCode": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "proposalIpReviewActivityId": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "activityNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Intellectual Property Review Activities
PATCH/instprop/api/v1/intellectual-property-review-activities/(key)

Example URI

PATCH /instprop/api/v1/intellectual-property-review-activities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ipReviewActivityTypeCode": "(val)",
  "activityDate": "(val)",
  "comments": "(val)",
  "proposalIpReviewActivityId": "(val)",
  "ipReviewId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "activityNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "ipReviewActivityTypeCode": "(val)",
  "activityDate": "(val)",
  "comments": "(val)",
  "proposalIpReviewActivityId": "(val)",
  "ipReviewId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "activityNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Intellectual Property Review Activities
POST/instprop/api/v1/intellectual-property-review-activities/

Example URI

POST /instprop/api/v1/intellectual-property-review-activities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ipReviewActivityTypeCode": "(val)",
  "activityDate": "(val)",
  "comments": "(val)",
  "proposalIpReviewActivityId": "(val)",
  "ipReviewId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "activityNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "ipReviewActivityTypeCode": "(val)",
  "activityDate": "(val)",
  "comments": "(val)",
  "proposalIpReviewActivityId": "(val)",
  "ipReviewId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "activityNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Intellectual Property Review Activities
POST/instprop/api/v1/intellectual-property-review-activities/

Example URI

POST /instprop/api/v1/intellectual-property-review-activities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "ipReviewActivityTypeCode": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "proposalIpReviewActivityId": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "activityNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ipReviewActivityTypeCode": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "proposalIpReviewActivityId": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "activityNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "ipReviewActivityTypeCode": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "proposalIpReviewActivityId": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "activityNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ipReviewActivityTypeCode": "(val)",
    "activityDate": "(val)",
    "comments": "(val)",
    "proposalIpReviewActivityId": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "activityNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Intellectual Property Review Activities by Key
DELETE/instprop/api/v1/intellectual-property-review-activities/(key)

Example URI

DELETE /instprop/api/v1/intellectual-property-review-activities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Intellectual Property Review Activities
DELETE/instprop/api/v1/intellectual-property-review-activities/

Example URI

DELETE /instprop/api/v1/intellectual-property-review-activities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Intellectual Property Review Activities with Matching
DELETE/instprop/api/v1/intellectual-property-review-activities/

Example URI

DELETE /instprop/api/v1/intellectual-property-review-activities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

ipReviewActivityTypeCode
string (optional) 

IP Review Activity Type Code. Maximum length is 22. Validating pattern is ^[0-9]*$.

activityDate
string (optional) 

Activity Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

comments
string (optional) 

Comments. Maximum length is 150. Validating pattern is ^[\p{Graph}\p{Space}]*$.

proposalIpReviewActivityId
string (optional) 

Proposal Ip Rev Activity Id. Maximum length is 22. Validating pattern is ^[0-9]*$.

ipReviewId
string (optional) 
proposalNumber
string (optional) 

Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 22. Validating pattern is ^[0-9]*$.

activityNumber
string (optional) 

Activity Number. Maximum length is 3. Validating pattern is ^[0-9]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Intellectual Property Review Activity Types

Get Intellectual Property Review Activity Types by Key
GET/instprop/api/v1/intellectual-property-review-activity-types/(key)

Example URI

GET /instprop/api/v1/intellectual-property-review-activity-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "intellectualPropertyReviewActivityTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Intellectual Property Review Activity Types
GET/instprop/api/v1/intellectual-property-review-activity-types/

Example URI

GET /instprop/api/v1/intellectual-property-review-activity-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "intellectualPropertyReviewActivityTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewActivityTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Intellectual Property Review Activity Types with Filtering
GET/instprop/api/v1/intellectual-property-review-activity-types/

Example URI

GET /instprop/api/v1/intellectual-property-review-activity-types/
URI Parameters
HideShow
intellectualPropertyReviewActivityTypeCode
string (optional) 

Intellectual Property Review Activity Type Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "intellectualPropertyReviewActivityTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewActivityTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Intellectual Property Review Activity Types
GET/instprop/api/v1/intellectual-property-review-activity-types/

Example URI

GET /instprop/api/v1/intellectual-property-review-activity-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "intellectualPropertyReviewActivityTypeCode",
    "description"
  ],
  "primaryKey": "intellectualPropertyReviewActivityTypeCode"
}

Get Blueprint API specification for Intellectual Property Review Activity Types
GET/instprop/api/v1/intellectual-property-review-activity-types/

Example URI

GET /instprop/api/v1/intellectual-property-review-activity-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Intellectual Property Review Activity Types.md"
transfer-encoding: chunked

Update Intellectual Property Review Activity Types
PUT/instprop/api/v1/intellectual-property-review-activity-types/(key)

Example URI

PUT /instprop/api/v1/intellectual-property-review-activity-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "intellectualPropertyReviewActivityTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Intellectual Property Review Activity Types
PUT/instprop/api/v1/intellectual-property-review-activity-types/

Example URI

PUT /instprop/api/v1/intellectual-property-review-activity-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "intellectualPropertyReviewActivityTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewActivityTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Intellectual Property Review Activity Types
PATCH/instprop/api/v1/intellectual-property-review-activity-types/(key)

Example URI

PATCH /instprop/api/v1/intellectual-property-review-activity-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "intellectualPropertyReviewActivityTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "intellectualPropertyReviewActivityTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Intellectual Property Review Activity Types
POST/instprop/api/v1/intellectual-property-review-activity-types/

Example URI

POST /instprop/api/v1/intellectual-property-review-activity-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "intellectualPropertyReviewActivityTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "intellectualPropertyReviewActivityTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Intellectual Property Review Activity Types
POST/instprop/api/v1/intellectual-property-review-activity-types/

Example URI

POST /instprop/api/v1/intellectual-property-review-activity-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "intellectualPropertyReviewActivityTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewActivityTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "intellectualPropertyReviewActivityTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewActivityTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Intellectual Property Review Activity Types by Key
DELETE/instprop/api/v1/intellectual-property-review-activity-types/(key)

Example URI

DELETE /instprop/api/v1/intellectual-property-review-activity-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Intellectual Property Review Activity Types
DELETE/instprop/api/v1/intellectual-property-review-activity-types/

Example URI

DELETE /instprop/api/v1/intellectual-property-review-activity-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Intellectual Property Review Activity Types with Matching
DELETE/instprop/api/v1/intellectual-property-review-activity-types/

Example URI

DELETE /instprop/api/v1/intellectual-property-review-activity-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

intellectualPropertyReviewActivityTypeCode
string (optional) 

Intellectual Property Review Activity Type Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Intellectual Property Review Requirement Types

Get Intellectual Property Review Requirement Types by Key
GET/instprop/api/v1/intellectual-property-review-requirement-types/(key)

Example URI

GET /instprop/api/v1/intellectual-property-review-requirement-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "intellectualPropertyReviewRequirementTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Intellectual Property Review Requirement Types
GET/instprop/api/v1/intellectual-property-review-requirement-types/

Example URI

GET /instprop/api/v1/intellectual-property-review-requirement-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "intellectualPropertyReviewRequirementTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewRequirementTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Intellectual Property Review Requirement Types with Filtering
GET/instprop/api/v1/intellectual-property-review-requirement-types/

Example URI

GET /instprop/api/v1/intellectual-property-review-requirement-types/
URI Parameters
HideShow
intellectualPropertyReviewRequirementTypeCode
string (optional) 

Intellectual Property Review Requirement Type Code. Maximum length is 3. Validating pattern is ^[\p{Graph}\p{Space}]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "intellectualPropertyReviewRequirementTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewRequirementTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Intellectual Property Review Requirement Types
GET/instprop/api/v1/intellectual-property-review-requirement-types/

Example URI

GET /instprop/api/v1/intellectual-property-review-requirement-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "intellectualPropertyReviewRequirementTypeCode",
    "description"
  ],
  "primaryKey": "intellectualPropertyReviewRequirementTypeCode"
}

Get Blueprint API specification for Intellectual Property Review Requirement Types
GET/instprop/api/v1/intellectual-property-review-requirement-types/

Example URI

GET /instprop/api/v1/intellectual-property-review-requirement-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Intellectual Property Review Requirement Types.md"
transfer-encoding: chunked

Update Intellectual Property Review Requirement Types
PUT/instprop/api/v1/intellectual-property-review-requirement-types/(key)

Example URI

PUT /instprop/api/v1/intellectual-property-review-requirement-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "intellectualPropertyReviewRequirementTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Intellectual Property Review Requirement Types
PUT/instprop/api/v1/intellectual-property-review-requirement-types/

Example URI

PUT /instprop/api/v1/intellectual-property-review-requirement-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "intellectualPropertyReviewRequirementTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewRequirementTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Intellectual Property Review Requirement Types
PATCH/instprop/api/v1/intellectual-property-review-requirement-types/(key)

Example URI

PATCH /instprop/api/v1/intellectual-property-review-requirement-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "intellectualPropertyReviewRequirementTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "intellectualPropertyReviewRequirementTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Intellectual Property Review Requirement Types
POST/instprop/api/v1/intellectual-property-review-requirement-types/

Example URI

POST /instprop/api/v1/intellectual-property-review-requirement-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "intellectualPropertyReviewRequirementTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "intellectualPropertyReviewRequirementTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Intellectual Property Review Requirement Types
POST/instprop/api/v1/intellectual-property-review-requirement-types/

Example URI

POST /instprop/api/v1/intellectual-property-review-requirement-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "intellectualPropertyReviewRequirementTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewRequirementTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "intellectualPropertyReviewRequirementTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewRequirementTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Intellectual Property Review Requirement Types by Key
DELETE/instprop/api/v1/intellectual-property-review-requirement-types/(key)

Example URI

DELETE /instprop/api/v1/intellectual-property-review-requirement-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Intellectual Property Review Requirement Types
DELETE/instprop/api/v1/intellectual-property-review-requirement-types/

Example URI

DELETE /instprop/api/v1/intellectual-property-review-requirement-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Intellectual Property Review Requirement Types with Matching
DELETE/instprop/api/v1/intellectual-property-review-requirement-types/

Example URI

DELETE /instprop/api/v1/intellectual-property-review-requirement-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

intellectualPropertyReviewRequirementTypeCode
string (optional) 

Intellectual Property Review Requirement Type Code. Maximum length is 3. Validating pattern is ^[\p{Graph}\p{Space}]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Intellectual Property Review Result Types

Get Intellectual Property Review Result Types by Key
GET/instprop/api/v1/intellectual-property-review-result-types/(key)

Example URI

GET /instprop/api/v1/intellectual-property-review-result-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "intellectualPropertyReviewResultTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Intellectual Property Review Result Types
GET/instprop/api/v1/intellectual-property-review-result-types/

Example URI

GET /instprop/api/v1/intellectual-property-review-result-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "intellectualPropertyReviewResultTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewResultTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Intellectual Property Review Result Types with Filtering
GET/instprop/api/v1/intellectual-property-review-result-types/

Example URI

GET /instprop/api/v1/intellectual-property-review-result-types/
URI Parameters
HideShow
intellectualPropertyReviewResultTypeCode
string (optional) 

Intellectual Property Review Result Type Code. Maximum length is 3. Validating pattern is ^[\p{Graph}\p{Space}]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "intellectualPropertyReviewResultTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewResultTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Intellectual Property Review Result Types
GET/instprop/api/v1/intellectual-property-review-result-types/

Example URI

GET /instprop/api/v1/intellectual-property-review-result-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "intellectualPropertyReviewResultTypeCode",
    "description"
  ],
  "primaryKey": "intellectualPropertyReviewResultTypeCode"
}

Get Blueprint API specification for Intellectual Property Review Result Types
GET/instprop/api/v1/intellectual-property-review-result-types/

Example URI

GET /instprop/api/v1/intellectual-property-review-result-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Intellectual Property Review Result Types.md"
transfer-encoding: chunked

Update Intellectual Property Review Result Types
PUT/instprop/api/v1/intellectual-property-review-result-types/(key)

Example URI

PUT /instprop/api/v1/intellectual-property-review-result-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "intellectualPropertyReviewResultTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Intellectual Property Review Result Types
PUT/instprop/api/v1/intellectual-property-review-result-types/

Example URI

PUT /instprop/api/v1/intellectual-property-review-result-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "intellectualPropertyReviewResultTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewResultTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Intellectual Property Review Result Types
PATCH/instprop/api/v1/intellectual-property-review-result-types/(key)

Example URI

PATCH /instprop/api/v1/intellectual-property-review-result-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "intellectualPropertyReviewResultTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "intellectualPropertyReviewResultTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Intellectual Property Review Result Types
POST/instprop/api/v1/intellectual-property-review-result-types/

Example URI

POST /instprop/api/v1/intellectual-property-review-result-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "intellectualPropertyReviewResultTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "intellectualPropertyReviewResultTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Intellectual Property Review Result Types
POST/instprop/api/v1/intellectual-property-review-result-types/

Example URI

POST /instprop/api/v1/intellectual-property-review-result-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "intellectualPropertyReviewResultTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewResultTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "intellectualPropertyReviewResultTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "intellectualPropertyReviewResultTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Intellectual Property Review Result Types by Key
DELETE/instprop/api/v1/intellectual-property-review-result-types/(key)

Example URI

DELETE /instprop/api/v1/intellectual-property-review-result-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Intellectual Property Review Result Types
DELETE/instprop/api/v1/intellectual-property-review-result-types/

Example URI

DELETE /instprop/api/v1/intellectual-property-review-result-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Intellectual Property Review Result Types with Matching
DELETE/instprop/api/v1/intellectual-property-review-result-types/

Example URI

DELETE /instprop/api/v1/intellectual-property-review-result-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

intellectualPropertyReviewResultTypeCode
string (optional) 

Intellectual Property Review Result Type Code. Maximum length is 3. Validating pattern is ^[\p{Graph}\p{Space}]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Intellectual Property Reviews

Get Intellectual Property Reviews by Key
GET/instprop/api/v1/intellectual-property-reviews/(key)

Example URI

GET /instprop/api/v1/intellectual-property-reviews/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "ipReviewer": "(val)",
  "ipReviewRequirementTypeCode": "(val)",
  "ipReviewSequenceStatus": "(val)",
  "reviewSubmissionDate": "(val)",
  "reviewResultCode": "(val)",
  "reviewReceiveDate": "(val)",
  "ipReviewId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Intellectual Property Reviews
GET/instprop/api/v1/intellectual-property-reviews/

Example URI

GET /instprop/api/v1/intellectual-property-reviews/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "ipReviewer": "(val)",
    "ipReviewRequirementTypeCode": "(val)",
    "ipReviewSequenceStatus": "(val)",
    "reviewSubmissionDate": "(val)",
    "reviewResultCode": "(val)",
    "reviewReceiveDate": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ipReviewer": "(val)",
    "ipReviewRequirementTypeCode": "(val)",
    "ipReviewSequenceStatus": "(val)",
    "reviewSubmissionDate": "(val)",
    "reviewResultCode": "(val)",
    "reviewReceiveDate": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Intellectual Property Reviews with Filtering
GET/instprop/api/v1/intellectual-property-reviews/

Example URI

GET /instprop/api/v1/intellectual-property-reviews/
URI Parameters
HideShow
ipReviewer
string (optional) 

KcPerson Id. Maximum length is 40. Validating pattern is ^[\p{Graph}]*$.

ipReviewRequirementTypeCode
string (optional) 

Review Requirement. Maximum length is 22. Validating pattern is ^[0-9]*$.

ipReviewSequenceStatus
string (optional) 
reviewSubmissionDate
string (optional) 

Submitted for Review. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

reviewResultCode
string (optional) 

Review Results. Maximum length is 22. Validating pattern is ^[0-9]*$.

reviewReceiveDate
string (optional) 

Date Finished Review. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

ipReviewId
string (optional) 
proposalNumber
string (optional) 

Institutional Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

sequenceNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "ipReviewer": "(val)",
    "ipReviewRequirementTypeCode": "(val)",
    "ipReviewSequenceStatus": "(val)",
    "reviewSubmissionDate": "(val)",
    "reviewResultCode": "(val)",
    "reviewReceiveDate": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ipReviewer": "(val)",
    "ipReviewRequirementTypeCode": "(val)",
    "ipReviewSequenceStatus": "(val)",
    "reviewSubmissionDate": "(val)",
    "reviewResultCode": "(val)",
    "reviewReceiveDate": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Intellectual Property Reviews
GET/instprop/api/v1/intellectual-property-reviews/

Example URI

GET /instprop/api/v1/intellectual-property-reviews/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "ipReviewer",
    "ipReviewRequirementTypeCode",
    "ipReviewSequenceStatus",
    "reviewSubmissionDate",
    "reviewResultCode",
    "reviewReceiveDate",
    "ipReviewId",
    "proposalNumber",
    "sequenceNumber"
  ],
  "primaryKey": "ipReviewId"
}

Get Blueprint API specification for Intellectual Property Reviews
GET/instprop/api/v1/intellectual-property-reviews/

Example URI

GET /instprop/api/v1/intellectual-property-reviews/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Intellectual Property Reviews.md"
transfer-encoding: chunked

Update Intellectual Property Reviews
PUT/instprop/api/v1/intellectual-property-reviews/(key)

Example URI

PUT /instprop/api/v1/intellectual-property-reviews/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ipReviewer": "(val)",
  "ipReviewRequirementTypeCode": "(val)",
  "ipReviewSequenceStatus": "(val)",
  "reviewSubmissionDate": "(val)",
  "reviewResultCode": "(val)",
  "reviewReceiveDate": "(val)",
  "ipReviewId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Intellectual Property Reviews
PUT/instprop/api/v1/intellectual-property-reviews/

Example URI

PUT /instprop/api/v1/intellectual-property-reviews/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "ipReviewer": "(val)",
    "ipReviewRequirementTypeCode": "(val)",
    "ipReviewSequenceStatus": "(val)",
    "reviewSubmissionDate": "(val)",
    "reviewResultCode": "(val)",
    "reviewReceiveDate": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ipReviewer": "(val)",
    "ipReviewRequirementTypeCode": "(val)",
    "ipReviewSequenceStatus": "(val)",
    "reviewSubmissionDate": "(val)",
    "reviewResultCode": "(val)",
    "reviewReceiveDate": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Intellectual Property Reviews
PATCH/instprop/api/v1/intellectual-property-reviews/(key)

Example URI

PATCH /instprop/api/v1/intellectual-property-reviews/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ipReviewer": "(val)",
  "ipReviewRequirementTypeCode": "(val)",
  "ipReviewSequenceStatus": "(val)",
  "reviewSubmissionDate": "(val)",
  "reviewResultCode": "(val)",
  "reviewReceiveDate": "(val)",
  "ipReviewId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "ipReviewer": "(val)",
  "ipReviewRequirementTypeCode": "(val)",
  "ipReviewSequenceStatus": "(val)",
  "reviewSubmissionDate": "(val)",
  "reviewResultCode": "(val)",
  "reviewReceiveDate": "(val)",
  "ipReviewId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Intellectual Property Reviews
POST/instprop/api/v1/intellectual-property-reviews/

Example URI

POST /instprop/api/v1/intellectual-property-reviews/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ipReviewer": "(val)",
  "ipReviewRequirementTypeCode": "(val)",
  "ipReviewSequenceStatus": "(val)",
  "reviewSubmissionDate": "(val)",
  "reviewResultCode": "(val)",
  "reviewReceiveDate": "(val)",
  "ipReviewId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "ipReviewer": "(val)",
  "ipReviewRequirementTypeCode": "(val)",
  "ipReviewSequenceStatus": "(val)",
  "reviewSubmissionDate": "(val)",
  "reviewResultCode": "(val)",
  "reviewReceiveDate": "(val)",
  "ipReviewId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Intellectual Property Reviews
POST/instprop/api/v1/intellectual-property-reviews/

Example URI

POST /instprop/api/v1/intellectual-property-reviews/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "ipReviewer": "(val)",
    "ipReviewRequirementTypeCode": "(val)",
    "ipReviewSequenceStatus": "(val)",
    "reviewSubmissionDate": "(val)",
    "reviewResultCode": "(val)",
    "reviewReceiveDate": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ipReviewer": "(val)",
    "ipReviewRequirementTypeCode": "(val)",
    "ipReviewSequenceStatus": "(val)",
    "reviewSubmissionDate": "(val)",
    "reviewResultCode": "(val)",
    "reviewReceiveDate": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "ipReviewer": "(val)",
    "ipReviewRequirementTypeCode": "(val)",
    "ipReviewSequenceStatus": "(val)",
    "reviewSubmissionDate": "(val)",
    "reviewResultCode": "(val)",
    "reviewReceiveDate": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ipReviewer": "(val)",
    "ipReviewRequirementTypeCode": "(val)",
    "ipReviewSequenceStatus": "(val)",
    "reviewSubmissionDate": "(val)",
    "reviewResultCode": "(val)",
    "reviewReceiveDate": "(val)",
    "ipReviewId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Intellectual Property Reviews by Key
DELETE/instprop/api/v1/intellectual-property-reviews/(key)

Example URI

DELETE /instprop/api/v1/intellectual-property-reviews/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Intellectual Property Reviews
DELETE/instprop/api/v1/intellectual-property-reviews/

Example URI

DELETE /instprop/api/v1/intellectual-property-reviews/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Intellectual Property Reviews with Matching
DELETE/instprop/api/v1/intellectual-property-reviews/

Example URI

DELETE /instprop/api/v1/intellectual-property-reviews/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

ipReviewer
string (optional) 

KcPerson Id. Maximum length is 40. Validating pattern is ^[\p{Graph}]*$.

ipReviewRequirementTypeCode
string (optional) 

Review Requirement. Maximum length is 22. Validating pattern is ^[0-9]*$.

ipReviewSequenceStatus
string (optional) 
reviewSubmissionDate
string (optional) 

Submitted for Review. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

reviewResultCode
string (optional) 

Review Results. Maximum length is 22. Validating pattern is ^[0-9]*$.

reviewReceiveDate
string (optional) 

Date Finished Review. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

ipReviewId
string (optional) 
proposalNumber
string (optional) 

Institutional Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

sequenceNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Proposal Admin Details

Get Proposal Admin Details by Key
GET/instprop/api/v1/proposal-admin-details/(key)

Example URI

GET /instprop/api/v1/proposal-admin-details/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalAdminDetailId": "(val)",
  "dateSubmittedByDept": "(val)",
  "dateReturnedToDept": "(val)",
  "dateApprovedByOsp": "(val)",
  "dateSubmittedToAgency": "(val)",
  "instPropCreateDate": "(val)",
  "instPropCreateUser": "(val)",
  "signedBy": "(val)",
  "submissionType": "(val)",
  "devProposalNumber": "(val)",
  "instProposalId": "(val)",
  "_primaryKey": "(val)"
}

Get All Proposal Admin Details
GET/instprop/api/v1/proposal-admin-details/

Example URI

GET /instprop/api/v1/proposal-admin-details/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalAdminDetailId": "(val)",
    "dateSubmittedByDept": "(val)",
    "dateReturnedToDept": "(val)",
    "dateApprovedByOsp": "(val)",
    "dateSubmittedToAgency": "(val)",
    "instPropCreateDate": "(val)",
    "instPropCreateUser": "(val)",
    "signedBy": "(val)",
    "submissionType": "(val)",
    "devProposalNumber": "(val)",
    "instProposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalAdminDetailId": "(val)",
    "dateSubmittedByDept": "(val)",
    "dateReturnedToDept": "(val)",
    "dateApprovedByOsp": "(val)",
    "dateSubmittedToAgency": "(val)",
    "instPropCreateDate": "(val)",
    "instPropCreateUser": "(val)",
    "signedBy": "(val)",
    "submissionType": "(val)",
    "devProposalNumber": "(val)",
    "instProposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Proposal Admin Details with Filtering
GET/instprop/api/v1/proposal-admin-details/

Example URI

GET /instprop/api/v1/proposal-admin-details/
URI Parameters
HideShow
proposalAdminDetailId
string (optional) 
dateSubmittedByDept
string (optional) 
dateReturnedToDept
string (optional) 
dateApprovedByOsp
string (optional) 
dateSubmittedToAgency
string (optional) 
instPropCreateDate
string (optional) 
instPropCreateUser
string (optional) 
signedBy
string (optional) 
submissionType
string (optional) 
devProposalNumber
string (optional) 
instProposalId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalAdminDetailId": "(val)",
    "dateSubmittedByDept": "(val)",
    "dateReturnedToDept": "(val)",
    "dateApprovedByOsp": "(val)",
    "dateSubmittedToAgency": "(val)",
    "instPropCreateDate": "(val)",
    "instPropCreateUser": "(val)",
    "signedBy": "(val)",
    "submissionType": "(val)",
    "devProposalNumber": "(val)",
    "instProposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalAdminDetailId": "(val)",
    "dateSubmittedByDept": "(val)",
    "dateReturnedToDept": "(val)",
    "dateApprovedByOsp": "(val)",
    "dateSubmittedToAgency": "(val)",
    "instPropCreateDate": "(val)",
    "instPropCreateUser": "(val)",
    "signedBy": "(val)",
    "submissionType": "(val)",
    "devProposalNumber": "(val)",
    "instProposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Proposal Admin Details
GET/instprop/api/v1/proposal-admin-details/

Example URI

GET /instprop/api/v1/proposal-admin-details/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalAdminDetailId",
    "dateSubmittedByDept",
    "dateReturnedToDept",
    "dateApprovedByOsp",
    "dateSubmittedToAgency",
    "instPropCreateDate",
    "instPropCreateUser",
    "signedBy",
    "submissionType",
    "devProposalNumber",
    "instProposalId"
  ],
  "primaryKey": "proposalAdminDetailId"
}

Get Blueprint API specification for Proposal Admin Details
GET/instprop/api/v1/proposal-admin-details/

Example URI

GET /instprop/api/v1/proposal-admin-details/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Admin Details.md"
transfer-encoding: chunked

Update Proposal Admin Details
PUT/instprop/api/v1/proposal-admin-details/(key)

Example URI

PUT /instprop/api/v1/proposal-admin-details/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalAdminDetailId": "(val)",
  "dateSubmittedByDept": "(val)",
  "dateReturnedToDept": "(val)",
  "dateApprovedByOsp": "(val)",
  "dateSubmittedToAgency": "(val)",
  "instPropCreateDate": "(val)",
  "instPropCreateUser": "(val)",
  "signedBy": "(val)",
  "submissionType": "(val)",
  "devProposalNumber": "(val)",
  "instProposalId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Proposal Admin Details
PUT/instprop/api/v1/proposal-admin-details/

Example URI

PUT /instprop/api/v1/proposal-admin-details/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalAdminDetailId": "(val)",
    "dateSubmittedByDept": "(val)",
    "dateReturnedToDept": "(val)",
    "dateApprovedByOsp": "(val)",
    "dateSubmittedToAgency": "(val)",
    "instPropCreateDate": "(val)",
    "instPropCreateUser": "(val)",
    "signedBy": "(val)",
    "submissionType": "(val)",
    "devProposalNumber": "(val)",
    "instProposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalAdminDetailId": "(val)",
    "dateSubmittedByDept": "(val)",
    "dateReturnedToDept": "(val)",
    "dateApprovedByOsp": "(val)",
    "dateSubmittedToAgency": "(val)",
    "instPropCreateDate": "(val)",
    "instPropCreateUser": "(val)",
    "signedBy": "(val)",
    "submissionType": "(val)",
    "devProposalNumber": "(val)",
    "instProposalId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Proposal Admin Details
PATCH/instprop/api/v1/proposal-admin-details/(key)

Example URI

PATCH /instprop/api/v1/proposal-admin-details/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalAdminDetailId": "(val)",
  "dateSubmittedByDept": "(val)",
  "dateReturnedToDept": "(val)",
  "dateApprovedByOsp": "(val)",
  "dateSubmittedToAgency": "(val)",
  "instPropCreateDate": "(val)",
  "instPropCreateUser": "(val)",
  "signedBy": "(val)",
  "submissionType": "(val)",
  "devProposalNumber": "(val)",
  "instProposalId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "proposalAdminDetailId": "(val)",
  "dateSubmittedByDept": "(val)",
  "dateReturnedToDept": "(val)",
  "dateApprovedByOsp": "(val)",
  "dateSubmittedToAgency": "(val)",
  "instPropCreateDate": "(val)",
  "instPropCreateUser": "(val)",
  "signedBy": "(val)",
  "submissionType": "(val)",
  "devProposalNumber": "(val)",
  "instProposalId": "(val)",
  "_primaryKey": "(val)"
}

Insert Proposal Admin Details
POST/instprop/api/v1/proposal-admin-details/

Example URI

POST /instprop/api/v1/proposal-admin-details/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalAdminDetailId": "(val)",
  "dateSubmittedByDept": "(val)",
  "dateReturnedToDept": "(val)",
  "dateApprovedByOsp": "(val)",
  "dateSubmittedToAgency": "(val)",
  "instPropCreateDate": "(val)",
  "instPropCreateUser": "(val)",
  "signedBy": "(val)",
  "submissionType": "(val)",
  "devProposalNumber": "(val)",
  "instProposalId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "proposalAdminDetailId": "(val)",
  "dateSubmittedByDept": "(val)",
  "dateReturnedToDept": "(val)",
  "dateApprovedByOsp": "(val)",
  "dateSubmittedToAgency": "(val)",
  "instPropCreateDate": "(val)",
  "instPropCreateUser": "(val)",
  "signedBy": "(val)",
  "submissionType": "(val)",
  "devProposalNumber": "(val)",
  "instProposalId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Proposal Admin Details
POST/instprop/api/v1/proposal-admin-details/

Example URI

POST /instprop/api/v1/proposal-admin-details/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalAdminDetailId": "(val)",
    "dateSubmittedByDept": "(val)",
    "dateReturnedToDept": "(val)",
    "dateApprovedByOsp": "(val)",
    "dateSubmittedToAgency": "(val)",
    "instPropCreateDate": "(val)",
    "instPropCreateUser": "(val)",
    "signedBy": "(val)",
    "submissionType": "(val)",
    "devProposalNumber": "(val)",
    "instProposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalAdminDetailId": "(val)",
    "dateSubmittedByDept": "(val)",
    "dateReturnedToDept": "(val)",
    "dateApprovedByOsp": "(val)",
    "dateSubmittedToAgency": "(val)",
    "instPropCreateDate": "(val)",
    "instPropCreateUser": "(val)",
    "signedBy": "(val)",
    "submissionType": "(val)",
    "devProposalNumber": "(val)",
    "instProposalId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "proposalAdminDetailId": "(val)",
    "dateSubmittedByDept": "(val)",
    "dateReturnedToDept": "(val)",
    "dateApprovedByOsp": "(val)",
    "dateSubmittedToAgency": "(val)",
    "instPropCreateDate": "(val)",
    "instPropCreateUser": "(val)",
    "signedBy": "(val)",
    "submissionType": "(val)",
    "devProposalNumber": "(val)",
    "instProposalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalAdminDetailId": "(val)",
    "dateSubmittedByDept": "(val)",
    "dateReturnedToDept": "(val)",
    "dateApprovedByOsp": "(val)",
    "dateSubmittedToAgency": "(val)",
    "instPropCreateDate": "(val)",
    "instPropCreateUser": "(val)",
    "signedBy": "(val)",
    "submissionType": "(val)",
    "devProposalNumber": "(val)",
    "instProposalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Proposal Admin Details by Key
DELETE/instprop/api/v1/proposal-admin-details/(key)

Example URI

DELETE /instprop/api/v1/proposal-admin-details/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Admin Details
DELETE/instprop/api/v1/proposal-admin-details/

Example URI

DELETE /instprop/api/v1/proposal-admin-details/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Admin Details with Matching
DELETE/instprop/api/v1/proposal-admin-details/

Example URI

DELETE /instprop/api/v1/proposal-admin-details/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

proposalAdminDetailId
string (optional) 
dateSubmittedByDept
string (optional) 
dateReturnedToDept
string (optional) 
dateApprovedByOsp
string (optional) 
dateSubmittedToAgency
string (optional) 
instPropCreateDate
string (optional) 
instPropCreateUser
string (optional) 
signedBy
string (optional) 
submissionType
string (optional) 
devProposalNumber
string (optional) 
instProposalId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Proposal Comments

Get Proposal Comments by Key
GET/instprop/api/v1/proposal-comments/(key)

Example URI

GET /instprop/api/v1/proposal-comments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalCommentsId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "commentTypeCode": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Get All Proposal Comments
GET/instprop/api/v1/proposal-comments/

Example URI

GET /instprop/api/v1/proposal-comments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Proposal Comments with Filtering
GET/instprop/api/v1/proposal-comments/

Example URI

GET /instprop/api/v1/proposal-comments/
URI Parameters
HideShow
proposalCommentsId
string (optional) 
proposalId
string (optional) 
proposalNumber
string (optional) 
sequenceNumber
string (optional) 
commentTypeCode
string (optional) 
comments
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Proposal Comments
GET/instprop/api/v1/proposal-comments/

Example URI

GET /instprop/api/v1/proposal-comments/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalCommentsId",
    "proposalId",
    "proposalNumber",
    "sequenceNumber",
    "commentTypeCode",
    "comments"
  ],
  "primaryKey": "proposalCommentsId"
}

Get Blueprint API specification for Proposal Comments
GET/instprop/api/v1/proposal-comments/

Example URI

GET /instprop/api/v1/proposal-comments/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Comments.md"
transfer-encoding: chunked

Update Proposal Comments
PUT/instprop/api/v1/proposal-comments/(key)

Example URI

PUT /instprop/api/v1/proposal-comments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalCommentsId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "commentTypeCode": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Proposal Comments
PUT/instprop/api/v1/proposal-comments/

Example URI

PUT /instprop/api/v1/proposal-comments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Proposal Comments
PATCH/instprop/api/v1/proposal-comments/(key)

Example URI

PATCH /instprop/api/v1/proposal-comments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalCommentsId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "commentTypeCode": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "proposalCommentsId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "commentTypeCode": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Proposal Comments
POST/instprop/api/v1/proposal-comments/

Example URI

POST /instprop/api/v1/proposal-comments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalCommentsId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "commentTypeCode": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "proposalCommentsId": "(val)",
  "proposalId": "(val)",
  "proposalNumber": "(val)",
  "sequenceNumber": "(val)",
  "commentTypeCode": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Proposal Comments
POST/instprop/api/v1/proposal-comments/

Example URI

POST /instprop/api/v1/proposal-comments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalCommentsId": "(val)",
    "proposalId": "(val)",
    "proposalNumber": "(val)",
    "sequenceNumber": "(val)",
    "commentTypeCode": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Proposal Comments by Key
DELETE/instprop/api/v1/proposal-comments/(key)

Example URI

DELETE /instprop/api/v1/proposal-comments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Comments
DELETE/instprop/api/v1/proposal-comments/

Example URI

DELETE /instprop/api/v1/proposal-comments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Comments with Matching
DELETE/instprop/api/v1/proposal-comments/

Example URI

DELETE /instprop/api/v1/proposal-comments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

proposalCommentsId
string (optional) 
proposalId
string (optional) 
proposalNumber
string (optional) 
sequenceNumber
string (optional) 
commentTypeCode
string (optional) 
comments
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Proposal Intellectual Property Review Joins

Get Proposal Intellectual Property Review Joins by Key
GET/instprop/api/v1/proposal-intellectual-property-review-joins/(key)

Example URI

GET /instprop/api/v1/proposal-intellectual-property-review-joins/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalIpReviewJoinId": "(val)",
  "proposalId": "(val)",
  "ipReviewId": "(val)",
  "_primaryKey": "(val)"
}

Get All Proposal Intellectual Property Review Joins
GET/instprop/api/v1/proposal-intellectual-property-review-joins/

Example URI

GET /instprop/api/v1/proposal-intellectual-property-review-joins/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalIpReviewJoinId": "(val)",
    "proposalId": "(val)",
    "ipReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalIpReviewJoinId": "(val)",
    "proposalId": "(val)",
    "ipReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Proposal Intellectual Property Review Joins with Filtering
GET/instprop/api/v1/proposal-intellectual-property-review-joins/

Example URI

GET /instprop/api/v1/proposal-intellectual-property-review-joins/
URI Parameters
HideShow
proposalIpReviewJoinId
string (optional) 
proposalId
string (optional) 
ipReviewId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalIpReviewJoinId": "(val)",
    "proposalId": "(val)",
    "ipReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalIpReviewJoinId": "(val)",
    "proposalId": "(val)",
    "ipReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Proposal Intellectual Property Review Joins
GET/instprop/api/v1/proposal-intellectual-property-review-joins/

Example URI

GET /instprop/api/v1/proposal-intellectual-property-review-joins/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalIpReviewJoinId",
    "proposalId",
    "ipReviewId"
  ],
  "primaryKey": "proposalIpReviewJoinId"
}

Get Blueprint API specification for Proposal Intellectual Property Review Joins
GET/instprop/api/v1/proposal-intellectual-property-review-joins/

Example URI

GET /instprop/api/v1/proposal-intellectual-property-review-joins/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Intellectual Property Review Joins.md"
transfer-encoding: chunked

Update Proposal Intellectual Property Review Joins
PUT/instprop/api/v1/proposal-intellectual-property-review-joins/(key)

Example URI

PUT /instprop/api/v1/proposal-intellectual-property-review-joins/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalIpReviewJoinId": "(val)",
  "proposalId": "(val)",
  "ipReviewId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Proposal Intellectual Property Review Joins
PUT/instprop/api/v1/proposal-intellectual-property-review-joins/

Example URI

PUT /instprop/api/v1/proposal-intellectual-property-review-joins/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalIpReviewJoinId": "(val)",
    "proposalId": "(val)",
    "ipReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalIpReviewJoinId": "(val)",
    "proposalId": "(val)",
    "ipReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Proposal Intellectual Property Review Joins
PATCH/instprop/api/v1/proposal-intellectual-property-review-joins/(key)

Example URI

PATCH /instprop/api/v1/proposal-intellectual-property-review-joins/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalIpReviewJoinId": "(val)",
  "proposalId": "(val)",
  "ipReviewId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "proposalIpReviewJoinId": "(val)",
  "proposalId": "(val)",
  "ipReviewId": "(val)",
  "_primaryKey": "(val)"
}

Insert Proposal Intellectual Property Review Joins
POST/instprop/api/v1/proposal-intellectual-property-review-joins/

Example URI

POST /instprop/api/v1/proposal-intellectual-property-review-joins/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalIpReviewJoinId": "(val)",
  "proposalId": "(val)",
  "ipReviewId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "proposalIpReviewJoinId": "(val)",
  "proposalId": "(val)",
  "ipReviewId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Proposal Intellectual Property Review Joins
POST/instprop/api/v1/proposal-intellectual-property-review-joins/

Example URI

POST /instprop/api/v1/proposal-intellectual-property-review-joins/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalIpReviewJoinId": "(val)",
    "proposalId": "(val)",
    "ipReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalIpReviewJoinId": "(val)",
    "proposalId": "(val)",
    "ipReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "proposalIpReviewJoinId": "(val)",
    "proposalId": "(val)",
    "ipReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalIpReviewJoinId": "(val)",
    "proposalId": "(val)",
    "ipReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Proposal Intellectual Property Review Joins by Key
DELETE/instprop/api/v1/proposal-intellectual-property-review-joins/(key)

Example URI

DELETE /instprop/api/v1/proposal-intellectual-property-review-joins/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Intellectual Property Review Joins
DELETE/instprop/api/v1/proposal-intellectual-property-review-joins/

Example URI

DELETE /instprop/api/v1/proposal-intellectual-property-review-joins/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Intellectual Property Review Joins with Matching
DELETE/instprop/api/v1/proposal-intellectual-property-review-joins/

Example URI

DELETE /instprop/api/v1/proposal-intellectual-property-review-joins/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

proposalIpReviewJoinId
string (optional) 
proposalId
string (optional) 
ipReviewId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Proposal Log Person Mass Changes

Get Proposal Log Person Mass Changes by Key
GET/instprop/api/v1/proposal-log-person-mass-changes/(key)

Example URI

GET /instprop/api/v1/proposal-log-person-mass-changes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalLogPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "principalInvestigator": "(val)",
  "_primaryKey": "(val)"
}

Get All Proposal Log Person Mass Changes
GET/instprop/api/v1/proposal-log-person-mass-changes/

Example URI

GET /instprop/api/v1/proposal-log-person-mass-changes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalLogPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "principalInvestigator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "principalInvestigator": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Proposal Log Person Mass Changes with Filtering
GET/instprop/api/v1/proposal-log-person-mass-changes/

Example URI

GET /instprop/api/v1/proposal-log-person-mass-changes/
URI Parameters
HideShow
proposalLogPersonMassChangeId
string (optional) 

Proposal Log Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.

personMassChangeId
string (optional) 

Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.

principalInvestigator
string (optional) 

Principal Investigator. Maximum length is 1. Validating pattern is .*.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalLogPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "principalInvestigator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "principalInvestigator": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Proposal Log Person Mass Changes
GET/instprop/api/v1/proposal-log-person-mass-changes/

Example URI

GET /instprop/api/v1/proposal-log-person-mass-changes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalLogPersonMassChangeId",
    "personMassChangeId",
    "principalInvestigator"
  ],
  "primaryKey": "proposalLogPersonMassChangeId"
}

Get Blueprint API specification for Proposal Log Person Mass Changes
GET/instprop/api/v1/proposal-log-person-mass-changes/

Example URI

GET /instprop/api/v1/proposal-log-person-mass-changes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Log Person Mass Changes.md"
transfer-encoding: chunked

Update Proposal Log Person Mass Changes
PUT/instprop/api/v1/proposal-log-person-mass-changes/(key)

Example URI

PUT /instprop/api/v1/proposal-log-person-mass-changes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalLogPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "principalInvestigator": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Proposal Log Person Mass Changes
PUT/instprop/api/v1/proposal-log-person-mass-changes/

Example URI

PUT /instprop/api/v1/proposal-log-person-mass-changes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalLogPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "principalInvestigator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "principalInvestigator": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Proposal Log Person Mass Changes
PATCH/instprop/api/v1/proposal-log-person-mass-changes/(key)

Example URI

PATCH /instprop/api/v1/proposal-log-person-mass-changes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalLogPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "principalInvestigator": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "proposalLogPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "principalInvestigator": "(val)",
  "_primaryKey": "(val)"
}

Insert Proposal Log Person Mass Changes
POST/instprop/api/v1/proposal-log-person-mass-changes/

Example URI

POST /instprop/api/v1/proposal-log-person-mass-changes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalLogPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "principalInvestigator": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "proposalLogPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "principalInvestigator": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Proposal Log Person Mass Changes
POST/instprop/api/v1/proposal-log-person-mass-changes/

Example URI

POST /instprop/api/v1/proposal-log-person-mass-changes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalLogPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "principalInvestigator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "principalInvestigator": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "proposalLogPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "principalInvestigator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "principalInvestigator": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Proposal Log Person Mass Changes by Key
DELETE/instprop/api/v1/proposal-log-person-mass-changes/(key)

Example URI

DELETE /instprop/api/v1/proposal-log-person-mass-changes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Log Person Mass Changes
DELETE/instprop/api/v1/proposal-log-person-mass-changes/

Example URI

DELETE /instprop/api/v1/proposal-log-person-mass-changes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Log Person Mass Changes with Matching
DELETE/instprop/api/v1/proposal-log-person-mass-changes/

Example URI

DELETE /instprop/api/v1/proposal-log-person-mass-changes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

proposalLogPersonMassChangeId
string (optional) 

Proposal Log Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.

personMassChangeId
string (optional) 

Person Mass Change Id. Maximum length is 12. Validating pattern is ^[0-9]*$.

principalInvestigator
string (optional) 

Principal Investigator. Maximum length is 1. Validating pattern is .*.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Proposal Log Statuses

Get Proposal Log Statuses by Key
GET/instprop/api/v1/proposal-log-statuses/(key)

Example URI

GET /instprop/api/v1/proposal-log-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalLogStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Proposal Log Statuses
GET/instprop/api/v1/proposal-log-statuses/

Example URI

GET /instprop/api/v1/proposal-log-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalLogStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Proposal Log Statuses with Filtering
GET/instprop/api/v1/proposal-log-statuses/

Example URI

GET /instprop/api/v1/proposal-log-statuses/
URI Parameters
HideShow
proposalLogStatusCode
string (optional) 

Proposal Log Status Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[A-Za-z0-9]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalLogStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Proposal Log Statuses
GET/instprop/api/v1/proposal-log-statuses/

Example URI

GET /instprop/api/v1/proposal-log-statuses/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalLogStatusCode",
    "description"
  ],
  "primaryKey": "proposalLogStatusCode"
}

Get Blueprint API specification for Proposal Log Statuses
GET/instprop/api/v1/proposal-log-statuses/

Example URI

GET /instprop/api/v1/proposal-log-statuses/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Log Statuses.md"
transfer-encoding: chunked

Update Proposal Log Statuses
PUT/instprop/api/v1/proposal-log-statuses/(key)

Example URI

PUT /instprop/api/v1/proposal-log-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalLogStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Proposal Log Statuses
PUT/instprop/api/v1/proposal-log-statuses/

Example URI

PUT /instprop/api/v1/proposal-log-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalLogStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Proposal Log Statuses
PATCH/instprop/api/v1/proposal-log-statuses/(key)

Example URI

PATCH /instprop/api/v1/proposal-log-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalLogStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "proposalLogStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Proposal Log Statuses
POST/instprop/api/v1/proposal-log-statuses/

Example URI

POST /instprop/api/v1/proposal-log-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalLogStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "proposalLogStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Proposal Log Statuses
POST/instprop/api/v1/proposal-log-statuses/

Example URI

POST /instprop/api/v1/proposal-log-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalLogStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "proposalLogStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Proposal Log Statuses by Key
DELETE/instprop/api/v1/proposal-log-statuses/(key)

Example URI

DELETE /instprop/api/v1/proposal-log-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Log Statuses
DELETE/instprop/api/v1/proposal-log-statuses/

Example URI

DELETE /instprop/api/v1/proposal-log-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Log Statuses with Matching
DELETE/instprop/api/v1/proposal-log-statuses/

Example URI

DELETE /instprop/api/v1/proposal-log-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

proposalLogStatusCode
string (optional) 

Proposal Log Status Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[A-Za-z0-9]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Proposal Log Types

Get Proposal Log Types by Key
GET/instprop/api/v1/proposal-log-types/(key)

Example URI

GET /instprop/api/v1/proposal-log-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalLogTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Proposal Log Types
GET/instprop/api/v1/proposal-log-types/

Example URI

GET /instprop/api/v1/proposal-log-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalLogTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Proposal Log Types with Filtering
GET/instprop/api/v1/proposal-log-types/

Example URI

GET /instprop/api/v1/proposal-log-types/
URI Parameters
HideShow
proposalLogTypeCode
string (optional) 

Proposal Log Type Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[A-Za-z0-9]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalLogTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Proposal Log Types
GET/instprop/api/v1/proposal-log-types/

Example URI

GET /instprop/api/v1/proposal-log-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalLogTypeCode",
    "description"
  ],
  "primaryKey": "proposalLogTypeCode"
}

Get Blueprint API specification for Proposal Log Types
GET/instprop/api/v1/proposal-log-types/

Example URI

GET /instprop/api/v1/proposal-log-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Log Types.md"
transfer-encoding: chunked

Update Proposal Log Types
PUT/instprop/api/v1/proposal-log-types/(key)

Example URI

PUT /instprop/api/v1/proposal-log-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalLogTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Proposal Log Types
PUT/instprop/api/v1/proposal-log-types/

Example URI

PUT /instprop/api/v1/proposal-log-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalLogTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Proposal Log Types
PATCH/instprop/api/v1/proposal-log-types/(key)

Example URI

PATCH /instprop/api/v1/proposal-log-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalLogTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "proposalLogTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Proposal Log Types
POST/instprop/api/v1/proposal-log-types/

Example URI

POST /instprop/api/v1/proposal-log-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalLogTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "proposalLogTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Proposal Log Types
POST/instprop/api/v1/proposal-log-types/

Example URI

POST /instprop/api/v1/proposal-log-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalLogTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "proposalLogTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalLogTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Proposal Log Types by Key
DELETE/instprop/api/v1/proposal-log-types/(key)

Example URI

DELETE /instprop/api/v1/proposal-log-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Log Types
DELETE/instprop/api/v1/proposal-log-types/

Example URI

DELETE /instprop/api/v1/proposal-log-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Log Types with Matching
DELETE/instprop/api/v1/proposal-log-types/

Example URI

DELETE /instprop/api/v1/proposal-log-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

proposalLogTypeCode
string (optional) 

Proposal Log Type Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[A-Za-z0-9]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Proposal Logs

Get Proposal Logs by Key
GET/instprop/api/v1/proposal-logs/(key)

Example URI

GET /instprop/api/v1/proposal-logs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalNumber": "(val)",
  "proposalTypeCode": "(val)",
  "proposalLogTypeCode": "(val)",
  "title": "(val)",
  "piId": "(val)",
  "mergedWith": "(val)",
  "instProposalNumber": "(val)",
  "rolodexId": "(val)",
  "piName": "(val)",
  "leadUnit": "(val)",
  "sponsorCode": "(val)",
  "sponsorName": "(val)",
  "logStatus": "(val)",
  "comments": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "deadlineDate": "(val)",
  "deadlineTime": "(val)",
  "fiscalMonth": "(val)",
  "fiscalYear": "(val)",
  "_primaryKey": "(val)"
}

Get All Proposal Logs
GET/instprop/api/v1/proposal-logs/

Example URI

GET /instprop/api/v1/proposal-logs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalNumber": "(val)",
    "proposalTypeCode": "(val)",
    "proposalLogTypeCode": "(val)",
    "title": "(val)",
    "piId": "(val)",
    "mergedWith": "(val)",
    "instProposalNumber": "(val)",
    "rolodexId": "(val)",
    "piName": "(val)",
    "leadUnit": "(val)",
    "sponsorCode": "(val)",
    "sponsorName": "(val)",
    "logStatus": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalNumber": "(val)",
    "proposalTypeCode": "(val)",
    "proposalLogTypeCode": "(val)",
    "title": "(val)",
    "piId": "(val)",
    "mergedWith": "(val)",
    "instProposalNumber": "(val)",
    "rolodexId": "(val)",
    "piName": "(val)",
    "leadUnit": "(val)",
    "sponsorCode": "(val)",
    "sponsorName": "(val)",
    "logStatus": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Proposal Logs with Filtering
GET/instprop/api/v1/proposal-logs/

Example URI

GET /instprop/api/v1/proposal-logs/
URI Parameters
HideShow
proposalNumber
string (optional) 

Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

proposalTypeCode
string (optional) 

Proposal Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.

proposalLogTypeCode
string (optional) 

Proposal Log Type Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

title
string (optional) 

Title. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

piId
string (optional) 

KcPerson Id. Maximum length is 40. Validating pattern is ^[\p{Graph}]*$.

mergedWith
string (optional) 

Proposal Merged With. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

instProposalNumber
string (optional) 

Created Institutional Proposal. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

rolodexId
string (optional) 

Rolodex Id. Maximum length is 6. Validating pattern is ^((-?[1-9][0-9])|[0])*$.

piName
string (optional) 

Principal Investigator. Maximum length is 123. Validating pattern is .*.

leadUnit
string (optional) 

Lead Unit. Maximum length is 20. Validating pattern is ^[\p{Graph}]*$.

sponsorCode
string (optional) 

Sponsor. Maximum length is 20. Validating pattern is ^[A-Za-z0-9]*$.

sponsorName
string (optional) 

Sponsor Name. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

logStatus
string (optional) 

Log Status. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

comments
string (optional) 

Comments. Maximum length is 300. Validating pattern is ^[\p{Graph}\p{Space}]*$.

createTimestamp
string (optional) 

Log Create Date. Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

createUser
string (optional) 

The user who created the object. Maximum length is 60. Validating pattern is ^[\p{Graph}]*$.

deadlineDate
string (optional) 

Deadline Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

deadlineTime
string (optional) 

The time in which the proposal is due to the sponsoring agency. Additional deadlines may be set by the office authorized to submit proposals on behalf of the institution (e.g. sponsored programs, etc.). Maximum length is 15. Validating pattern is .*.

fiscalMonth
string (optional) 

Fiscal Month. Maximum length is 2. Validating pattern is ^[0-9]*$.

fiscalYear
string (optional) 

Fiscal Year. Maximum length is 4. Validating pattern is ^[A-Za-z0-9]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalNumber": "(val)",
    "proposalTypeCode": "(val)",
    "proposalLogTypeCode": "(val)",
    "title": "(val)",
    "piId": "(val)",
    "mergedWith": "(val)",
    "instProposalNumber": "(val)",
    "rolodexId": "(val)",
    "piName": "(val)",
    "leadUnit": "(val)",
    "sponsorCode": "(val)",
    "sponsorName": "(val)",
    "logStatus": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalNumber": "(val)",
    "proposalTypeCode": "(val)",
    "proposalLogTypeCode": "(val)",
    "title": "(val)",
    "piId": "(val)",
    "mergedWith": "(val)",
    "instProposalNumber": "(val)",
    "rolodexId": "(val)",
    "piName": "(val)",
    "leadUnit": "(val)",
    "sponsorCode": "(val)",
    "sponsorName": "(val)",
    "logStatus": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Proposal Logs
GET/instprop/api/v1/proposal-logs/

Example URI

GET /instprop/api/v1/proposal-logs/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalNumber",
    "proposalTypeCode",
    "proposalLogTypeCode",
    "title",
    "piId",
    "mergedWith",
    "instProposalNumber",
    "rolodexId",
    "piName",
    "leadUnit",
    "sponsorCode",
    "sponsorName",
    "logStatus",
    "comments",
    "createTimestamp",
    "createUser",
    "deadlineDate",
    "deadlineTime",
    "fiscalMonth",
    "fiscalYear"
  ],
  "primaryKey": "proposalNumber"
}

Get Blueprint API specification for Proposal Logs
GET/instprop/api/v1/proposal-logs/

Example URI

GET /instprop/api/v1/proposal-logs/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Logs.md"
transfer-encoding: chunked

Update Proposal Logs
PUT/instprop/api/v1/proposal-logs/(key)

Example URI

PUT /instprop/api/v1/proposal-logs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalNumber": "(val)",
  "proposalTypeCode": "(val)",
  "proposalLogTypeCode": "(val)",
  "title": "(val)",
  "piId": "(val)",
  "mergedWith": "(val)",
  "instProposalNumber": "(val)",
  "rolodexId": "(val)",
  "piName": "(val)",
  "leadUnit": "(val)",
  "sponsorCode": "(val)",
  "sponsorName": "(val)",
  "logStatus": "(val)",
  "comments": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "deadlineDate": "(val)",
  "deadlineTime": "(val)",
  "fiscalMonth": "(val)",
  "fiscalYear": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Proposal Logs
PUT/instprop/api/v1/proposal-logs/

Example URI

PUT /instprop/api/v1/proposal-logs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalNumber": "(val)",
    "proposalTypeCode": "(val)",
    "proposalLogTypeCode": "(val)",
    "title": "(val)",
    "piId": "(val)",
    "mergedWith": "(val)",
    "instProposalNumber": "(val)",
    "rolodexId": "(val)",
    "piName": "(val)",
    "leadUnit": "(val)",
    "sponsorCode": "(val)",
    "sponsorName": "(val)",
    "logStatus": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalNumber": "(val)",
    "proposalTypeCode": "(val)",
    "proposalLogTypeCode": "(val)",
    "title": "(val)",
    "piId": "(val)",
    "mergedWith": "(val)",
    "instProposalNumber": "(val)",
    "rolodexId": "(val)",
    "piName": "(val)",
    "leadUnit": "(val)",
    "sponsorCode": "(val)",
    "sponsorName": "(val)",
    "logStatus": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Proposal Logs
PATCH/instprop/api/v1/proposal-logs/(key)

Example URI

PATCH /instprop/api/v1/proposal-logs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalNumber": "(val)",
  "proposalTypeCode": "(val)",
  "proposalLogTypeCode": "(val)",
  "title": "(val)",
  "piId": "(val)",
  "mergedWith": "(val)",
  "instProposalNumber": "(val)",
  "rolodexId": "(val)",
  "piName": "(val)",
  "leadUnit": "(val)",
  "sponsorCode": "(val)",
  "sponsorName": "(val)",
  "logStatus": "(val)",
  "comments": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "deadlineDate": "(val)",
  "deadlineTime": "(val)",
  "fiscalMonth": "(val)",
  "fiscalYear": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "proposalNumber": "(val)",
  "proposalTypeCode": "(val)",
  "proposalLogTypeCode": "(val)",
  "title": "(val)",
  "piId": "(val)",
  "mergedWith": "(val)",
  "instProposalNumber": "(val)",
  "rolodexId": "(val)",
  "piName": "(val)",
  "leadUnit": "(val)",
  "sponsorCode": "(val)",
  "sponsorName": "(val)",
  "logStatus": "(val)",
  "comments": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "deadlineDate": "(val)",
  "deadlineTime": "(val)",
  "fiscalMonth": "(val)",
  "fiscalYear": "(val)",
  "_primaryKey": "(val)"
}

Insert Proposal Logs
POST/instprop/api/v1/proposal-logs/

Example URI

POST /instprop/api/v1/proposal-logs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalNumber": "(val)",
  "proposalTypeCode": "(val)",
  "proposalLogTypeCode": "(val)",
  "title": "(val)",
  "piId": "(val)",
  "mergedWith": "(val)",
  "instProposalNumber": "(val)",
  "rolodexId": "(val)",
  "piName": "(val)",
  "leadUnit": "(val)",
  "sponsorCode": "(val)",
  "sponsorName": "(val)",
  "logStatus": "(val)",
  "comments": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "deadlineDate": "(val)",
  "deadlineTime": "(val)",
  "fiscalMonth": "(val)",
  "fiscalYear": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "proposalNumber": "(val)",
  "proposalTypeCode": "(val)",
  "proposalLogTypeCode": "(val)",
  "title": "(val)",
  "piId": "(val)",
  "mergedWith": "(val)",
  "instProposalNumber": "(val)",
  "rolodexId": "(val)",
  "piName": "(val)",
  "leadUnit": "(val)",
  "sponsorCode": "(val)",
  "sponsorName": "(val)",
  "logStatus": "(val)",
  "comments": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "deadlineDate": "(val)",
  "deadlineTime": "(val)",
  "fiscalMonth": "(val)",
  "fiscalYear": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Proposal Logs
POST/instprop/api/v1/proposal-logs/

Example URI

POST /instprop/api/v1/proposal-logs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalNumber": "(val)",
    "proposalTypeCode": "(val)",
    "proposalLogTypeCode": "(val)",
    "title": "(val)",
    "piId": "(val)",
    "mergedWith": "(val)",
    "instProposalNumber": "(val)",
    "rolodexId": "(val)",
    "piName": "(val)",
    "leadUnit": "(val)",
    "sponsorCode": "(val)",
    "sponsorName": "(val)",
    "logStatus": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalNumber": "(val)",
    "proposalTypeCode": "(val)",
    "proposalLogTypeCode": "(val)",
    "title": "(val)",
    "piId": "(val)",
    "mergedWith": "(val)",
    "instProposalNumber": "(val)",
    "rolodexId": "(val)",
    "piName": "(val)",
    "leadUnit": "(val)",
    "sponsorCode": "(val)",
    "sponsorName": "(val)",
    "logStatus": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "proposalNumber": "(val)",
    "proposalTypeCode": "(val)",
    "proposalLogTypeCode": "(val)",
    "title": "(val)",
    "piId": "(val)",
    "mergedWith": "(val)",
    "instProposalNumber": "(val)",
    "rolodexId": "(val)",
    "piName": "(val)",
    "leadUnit": "(val)",
    "sponsorCode": "(val)",
    "sponsorName": "(val)",
    "logStatus": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalNumber": "(val)",
    "proposalTypeCode": "(val)",
    "proposalLogTypeCode": "(val)",
    "title": "(val)",
    "piId": "(val)",
    "mergedWith": "(val)",
    "instProposalNumber": "(val)",
    "rolodexId": "(val)",
    "piName": "(val)",
    "leadUnit": "(val)",
    "sponsorCode": "(val)",
    "sponsorName": "(val)",
    "logStatus": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "deadlineDate": "(val)",
    "deadlineTime": "(val)",
    "fiscalMonth": "(val)",
    "fiscalYear": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Proposal Logs by Key
DELETE/instprop/api/v1/proposal-logs/(key)

Example URI

DELETE /instprop/api/v1/proposal-logs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Logs
DELETE/instprop/api/v1/proposal-logs/

Example URI

DELETE /instprop/api/v1/proposal-logs/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Logs with Matching
DELETE/instprop/api/v1/proposal-logs/

Example URI

DELETE /instprop/api/v1/proposal-logs/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

proposalNumber
string (optional) 

Proposal Number. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

proposalTypeCode
string (optional) 

Proposal Type Code. Maximum length is 3. Validating pattern is ^[0-9]*$.

proposalLogTypeCode
string (optional) 

Proposal Log Type Code. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

title
string (optional) 

Title. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

piId
string (optional) 

KcPerson Id. Maximum length is 40. Validating pattern is ^[\p{Graph}]*$.

mergedWith
string (optional) 

Proposal Merged With. Maximum length is 8. Validating pattern is ^[A-Za-z0-9]*$.

instProposalNumber
string (optional) 

Created Institutional Proposal. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

rolodexId
string (optional) 

Rolodex Id. Maximum length is 6. Validating pattern is ^((-?[1-9][0-9])|[0])*$.

piName
string (optional) 

Principal Investigator. Maximum length is 123. Validating pattern is .*.

leadUnit
string (optional) 

Lead Unit. Maximum length is 20. Validating pattern is ^[\p{Graph}]*$.

sponsorCode
string (optional) 

Sponsor. Maximum length is 20. Validating pattern is ^[A-Za-z0-9]*$.

sponsorName
string (optional) 

Sponsor Name. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

logStatus
string (optional) 

Log Status. Maximum length is 3. Validating pattern is ^[A-Za-z0-9]*$.

comments
string (optional) 

Comments. Maximum length is 300. Validating pattern is ^[\p{Graph}\p{Space}]*$.

createTimestamp
string (optional) 

Log Create Date. Maximum length is 21. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

createUser
string (optional) 

The user who created the object. Maximum length is 60. Validating pattern is ^[\p{Graph}]*$.

deadlineDate
string (optional) 

Deadline Date. Maximum length is 10. Validating pattern is ^(19|2[0-9])[0-9]{2}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$.

deadlineTime
string (optional) 

The time in which the proposal is due to the sponsoring agency. Additional deadlines may be set by the office authorized to submit proposals on behalf of the institution (e.g. sponsored programs, etc.). Maximum length is 15. Validating pattern is .*.

fiscalMonth
string (optional) 

Fiscal Month. Maximum length is 2. Validating pattern is ^[0-9]*$.

fiscalYear
string (optional) 

Fiscal Year. Maximum length is 4. Validating pattern is ^[A-Za-z0-9]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Proposal Statuses

Get Proposal Statuses by Key
GET/instprop/api/v1/proposal-statuses/(key)

Example URI

GET /instprop/api/v1/proposal-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "proposalStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Proposal Statuses
GET/instprop/api/v1/proposal-statuses/

Example URI

GET /instprop/api/v1/proposal-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Proposal Statuses with Filtering
GET/instprop/api/v1/proposal-statuses/

Example URI

GET /instprop/api/v1/proposal-statuses/
URI Parameters
HideShow
proposalStatusCode
string (optional) 

Proposal Status Code. Maximum length is 22. Validating pattern is ^[0-9]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "proposalStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Proposal Statuses
GET/instprop/api/v1/proposal-statuses/

Example URI

GET /instprop/api/v1/proposal-statuses/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "proposalStatusCode",
    "description"
  ],
  "primaryKey": "proposalStatusCode"
}

Get Blueprint API specification for Proposal Statuses
GET/instprop/api/v1/proposal-statuses/

Example URI

GET /instprop/api/v1/proposal-statuses/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Statuses.md"
transfer-encoding: chunked

Update Proposal Statuses
PUT/instprop/api/v1/proposal-statuses/(key)

Example URI

PUT /instprop/api/v1/proposal-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Proposal Statuses
PUT/instprop/api/v1/proposal-statuses/

Example URI

PUT /instprop/api/v1/proposal-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Proposal Statuses
PATCH/instprop/api/v1/proposal-statuses/(key)

Example URI

PATCH /instprop/api/v1/proposal-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "proposalStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Proposal Statuses
POST/instprop/api/v1/proposal-statuses/

Example URI

POST /instprop/api/v1/proposal-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "proposalStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "proposalStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Proposal Statuses
POST/instprop/api/v1/proposal-statuses/

Example URI

POST /instprop/api/v1/proposal-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "proposalStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "proposalStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "proposalStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Proposal Statuses by Key
DELETE/instprop/api/v1/proposal-statuses/(key)

Example URI

DELETE /instprop/api/v1/proposal-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Statuses
DELETE/instprop/api/v1/proposal-statuses/

Example URI

DELETE /instprop/api/v1/proposal-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposal Statuses with Matching
DELETE/instprop/api/v1/proposal-statuses/

Example URI

DELETE /instprop/api/v1/proposal-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

proposalStatusCode
string (optional) 

Proposal Status Code. Maximum length is 22. Validating pattern is ^[0-9]*$.

description
string (optional) 

Description. Maximum length is 200. Validating pattern is ^[\p{Graph}\p{Space}]*$.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Generated by aglio on 12 Oct 2020