API Documentation
Kuali Research REST APIs - Common
Research Common ¶
Answer Headers ¶
Get Answer Headers by KeyGET/research-common/api/v1/answer-headers/(key)
Example URI
GET /research-common/api/v1/answer-headers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
}Get All Answer HeadersGET/research-common/api/v1/answer-headers/
Example URI
GET /research-common/api/v1/answer-headers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
}
]Get All Answer Headers with FilteringGET/research-common/api/v1/answer-headers/
Example URI
GET /research-common/api/v1/answer-headers/
URI Parameters
- id
string(optional)- moduleItemCode
string(optional)- moduleItemKey
string(optional)- moduleSubItemCode
string(optional)- moduleSubItemKey
string(optional)- questionnaireId
string(optional)- completed
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Answer HeadersGET/research-common/api/v1/answer-headers/
Example URI
GET /research-common/api/v1/answer-headers/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"moduleItemCode",
"moduleItemKey",
"moduleSubItemCode",
"moduleSubItemKey",
"questionnaireId",
"completed"
],
"primaryKey": "id"
}Get Blueprint API specification for Answer HeadersGET/research-common/api/v1/answer-headers/
Example URI
GET /research-common/api/v1/answer-headers/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Answer Headers.md"
transfer-encoding: chunkedUpdate Answer HeadersPUT/research-common/api/v1/answer-headers/(key)
Example URI
PUT /research-common/api/v1/answer-headers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Answer HeadersPUT/research-common/api/v1/answer-headers/
Example URI
PUT /research-common/api/v1/answer-headers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Answer HeadersPATCH/research-common/api/v1/answer-headers/(key)
Example URI
PATCH /research-common/api/v1/answer-headers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
}Insert Answer HeadersPOST/research-common/api/v1/answer-headers/
Example URI
POST /research-common/api/v1/answer-headers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Answer HeadersPOST/research-common/api/v1/answer-headers/
Example URI
POST /research-common/api/v1/answer-headers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleItemKey": "(val)",
"moduleSubItemCode": "(val)",
"moduleSubItemKey": "(val)",
"questionnaireId": "(val)",
"completed": "(val)",
"_primaryKey": "(val)"
}
]Delete Answer Headers by KeyDELETE/research-common/api/v1/answer-headers/(key)
Example URI
DELETE /research-common/api/v1/answer-headers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Answer HeadersDELETE/research-common/api/v1/answer-headers/
Example URI
DELETE /research-common/api/v1/answer-headers/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Answer Headers with MatchingDELETE/research-common/api/v1/answer-headers/
Example URI
DELETE /research-common/api/v1/answer-headers/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)- moduleItemCode
string(optional)- moduleItemKey
string(optional)- moduleSubItemCode
string(optional)- moduleSubItemKey
string(optional)- questionnaireId
string(optional)- completed
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Account Types ¶
Get Account Types by KeyGET/research-common/api/v1/account-types/(key)
Example URI
GET /research-common/api/v1/account-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Account TypesGET/research-common/api/v1/account-types/
Example URI
GET /research-common/api/v1/account-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Account Types with FilteringGET/research-common/api/v1/account-types/
Example URI
GET /research-common/api/v1/account-types/
URI Parameters
- accountTypeCode
string(optional)Account Type Code. Maximum length is 22.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Account TypesGET/research-common/api/v1/account-types/
Example URI
GET /research-common/api/v1/account-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"accountTypeCode",
"description"
],
"primaryKey": "accountTypeCode"
}Get Blueprint API specification for Account TypesGET/research-common/api/v1/account-types/
Example URI
GET /research-common/api/v1/account-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Account Types.md"
transfer-encoding: chunkedUpdate Account TypesPUT/research-common/api/v1/account-types/(key)
Example URI
PUT /research-common/api/v1/account-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Account TypesPUT/research-common/api/v1/account-types/
Example URI
PUT /research-common/api/v1/account-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Account TypesPATCH/research-common/api/v1/account-types/(key)
Example URI
PATCH /research-common/api/v1/account-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Account TypesPOST/research-common/api/v1/account-types/
Example URI
POST /research-common/api/v1/account-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Account TypesPOST/research-common/api/v1/account-types/
Example URI
POST /research-common/api/v1/account-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"accountTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Account Types by KeyDELETE/research-common/api/v1/account-types/(key)
Example URI
DELETE /research-common/api/v1/account-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Account TypesDELETE/research-common/api/v1/account-types/
Example URI
DELETE /research-common/api/v1/account-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Account Types with MatchingDELETE/research-common/api/v1/account-types/
Example URI
DELETE /research-common/api/v1/account-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- accountTypeCode
string(optional)Account Type Code. Maximum length is 22.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Activity Types ¶
Get Activity Types by KeyGET/research-common/api/v1/activity-types/(key)
Example URI
GET /research-common/api/v1/activity-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
}Get All Activity TypesGET/research-common/api/v1/activity-types/
Example URI
GET /research-common/api/v1/activity-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Activity Types with FilteringGET/research-common/api/v1/activity-types/
Example URI
GET /research-common/api/v1/activity-types/
URI Parameters
- code
string(optional)Activity Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- higherEducationFunctionCode
string(optional)Higher education function code. Maximum length is 20.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Activity TypesGET/research-common/api/v1/activity-types/
Example URI
GET /research-common/api/v1/activity-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description",
"higherEducationFunctionCode"
],
"primaryKey": "code"
}Get Blueprint API specification for Activity TypesGET/research-common/api/v1/activity-types/
Example URI
GET /research-common/api/v1/activity-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Activity Types.md"
transfer-encoding: chunkedUpdate Activity TypesPUT/research-common/api/v1/activity-types/(key)
Example URI
PUT /research-common/api/v1/activity-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Activity TypesPUT/research-common/api/v1/activity-types/
Example URI
PUT /research-common/api/v1/activity-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Activity TypesPATCH/research-common/api/v1/activity-types/(key)
Example URI
PATCH /research-common/api/v1/activity-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
}Insert Activity TypesPOST/research-common/api/v1/activity-types/
Example URI
POST /research-common/api/v1/activity-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Activity TypesPOST/research-common/api/v1/activity-types/
Example URI
POST /research-common/api/v1/activity-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"higherEducationFunctionCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Activity Types by KeyDELETE/research-common/api/v1/activity-types/(key)
Example URI
DELETE /research-common/api/v1/activity-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Activity TypesDELETE/research-common/api/v1/activity-types/
Example URI
DELETE /research-common/api/v1/activity-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Activity Types with MatchingDELETE/research-common/api/v1/activity-types/
Example URI
DELETE /research-common/api/v1/activity-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Activity Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- higherEducationFunctionCode
string(optional)Higher education function code. Maximum length is 20.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Answers ¶
Get Answers by KeyGET/research-common/api/v1/answers/(key)
Example URI
GET /research-common/api/v1/answers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}Get All AnswersGET/research-common/api/v1/answers/
Example URI
GET /research-common/api/v1/answers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}
]Get All Answers with FilteringGET/research-common/api/v1/answers/
Example URI
GET /research-common/api/v1/answers/
URI Parameters
- id
string(optional)- answerHeaderId
string(optional)- questionId
string(optional)- questionnaireQuestionsId
string(optional)- questionNumber
string(optional)- answerNumber
string(optional)- answer
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for AnswersGET/research-common/api/v1/answers/
Example URI
GET /research-common/api/v1/answers/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"answerHeaderId",
"questionId",
"questionnaireQuestionsId",
"questionNumber",
"answerNumber",
"answer"
],
"primaryKey": "id"
}Get Blueprint API specification for AnswersGET/research-common/api/v1/answers/
Example URI
GET /research-common/api/v1/answers/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Answers.md"
transfer-encoding: chunkedUpdate AnswersPUT/research-common/api/v1/answers/(key)
Example URI
PUT /research-common/api/v1/answers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple AnswersPUT/research-common/api/v1/answers/
Example URI
PUT /research-common/api/v1/answers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes AnswersPATCH/research-common/api/v1/answers/(key)
Example URI
PATCH /research-common/api/v1/answers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}Insert AnswersPOST/research-common/api/v1/answers/
Example URI
POST /research-common/api/v1/answers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}Insert Multiple AnswersPOST/research-common/api/v1/answers/
Example URI
POST /research-common/api/v1/answers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"answerHeaderId": "(val)",
"questionId": "(val)",
"questionnaireQuestionsId": "(val)",
"questionNumber": "(val)",
"answerNumber": "(val)",
"answer": "(val)",
"_primaryKey": "(val)"
}
]Delete Answers by KeyDELETE/research-common/api/v1/answers/(key)
Example URI
DELETE /research-common/api/v1/answers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All AnswersDELETE/research-common/api/v1/answers/
Example URI
DELETE /research-common/api/v1/answers/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Answers with MatchingDELETE/research-common/api/v1/answers/
Example URI
DELETE /research-common/api/v1/answers/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)- answerHeaderId
string(optional)- questionId
string(optional)- questionnaireQuestionsId
string(optional)- questionNumber
string(optional)- answerNumber
string(optional)- answer
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Appointment Types ¶
Get Appointment Types by KeyGET/research-common/api/v1/appointment-types/(key)
Example URI
GET /research-common/api/v1/appointment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Appointment TypesGET/research-common/api/v1/appointment-types/
Example URI
GET /research-common/api/v1/appointment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Appointment Types with FilteringGET/research-common/api/v1/appointment-types/
Example URI
GET /research-common/api/v1/appointment-types/
URI Parameters
- appointmentTypeCode
string(optional)Appointment Type Code. Maximum length is 3.
- duration
string(optional)Duration. Maximum length is 5.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Appointment TypesGET/research-common/api/v1/appointment-types/
Example URI
GET /research-common/api/v1/appointment-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"appointmentTypeCode",
"duration",
"description"
],
"primaryKey": "appointmentTypeCode"
}Get Blueprint API specification for Appointment TypesGET/research-common/api/v1/appointment-types/
Example URI
GET /research-common/api/v1/appointment-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Appointment Types.md"
transfer-encoding: chunkedUpdate Appointment TypesPUT/research-common/api/v1/appointment-types/(key)
Example URI
PUT /research-common/api/v1/appointment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Appointment TypesPUT/research-common/api/v1/appointment-types/
Example URI
PUT /research-common/api/v1/appointment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Appointment TypesPATCH/research-common/api/v1/appointment-types/(key)
Example URI
PATCH /research-common/api/v1/appointment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Appointment TypesPOST/research-common/api/v1/appointment-types/
Example URI
POST /research-common/api/v1/appointment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Appointment TypesPOST/research-common/api/v1/appointment-types/
Example URI
POST /research-common/api/v1/appointment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"appointmentTypeCode": "(val)",
"duration": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Appointment Types by KeyDELETE/research-common/api/v1/appointment-types/(key)
Example URI
DELETE /research-common/api/v1/appointment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Appointment TypesDELETE/research-common/api/v1/appointment-types/
Example URI
DELETE /research-common/api/v1/appointment-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Appointment Types with MatchingDELETE/research-common/api/v1/appointment-types/
Example URI
DELETE /research-common/api/v1/appointment-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- appointmentTypeCode
string(optional)Appointment Type Code. Maximum length is 3.
- duration
string(optional)Duration. Maximum length is 5.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Arg Value Lookups ¶
Get Arg Value Lookups by KeyGET/research-common/api/v1/arg-value-lookups/(key)
Example URI
GET /research-common/api/v1/arg-value-lookups/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Arg Value LookupsGET/research-common/api/v1/arg-value-lookups/
Example URI
GET /research-common/api/v1/arg-value-lookups/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Arg Value Lookups with FilteringGET/research-common/api/v1/arg-value-lookups/
Example URI
GET /research-common/api/v1/arg-value-lookups/
URI Parameters
- id
string(optional)Arg Value Lookup Id. Maximum length is 12.
- argumentName
string(optional)Argument Name. Maximum length is 30.
- value
string(optional)Value. Maximum length is 200.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Arg Value LookupsGET/research-common/api/v1/arg-value-lookups/
Example URI
GET /research-common/api/v1/arg-value-lookups/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"argumentName",
"value",
"description"
],
"primaryKey": "id"
}Get Blueprint API specification for Arg Value LookupsGET/research-common/api/v1/arg-value-lookups/
Example URI
GET /research-common/api/v1/arg-value-lookups/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Arg Value Lookups.md"
transfer-encoding: chunkedUpdate Arg Value LookupsPUT/research-common/api/v1/arg-value-lookups/(key)
Example URI
PUT /research-common/api/v1/arg-value-lookups/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Arg Value LookupsPUT/research-common/api/v1/arg-value-lookups/
Example URI
PUT /research-common/api/v1/arg-value-lookups/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Arg Value LookupsPATCH/research-common/api/v1/arg-value-lookups/(key)
Example URI
PATCH /research-common/api/v1/arg-value-lookups/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Arg Value LookupsPOST/research-common/api/v1/arg-value-lookups/
Example URI
POST /research-common/api/v1/arg-value-lookups/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Arg Value LookupsPOST/research-common/api/v1/arg-value-lookups/
Example URI
POST /research-common/api/v1/arg-value-lookups/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"argumentName": "(val)",
"value": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Arg Value Lookups by KeyDELETE/research-common/api/v1/arg-value-lookups/(key)
Example URI
DELETE /research-common/api/v1/arg-value-lookups/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Arg Value LookupsDELETE/research-common/api/v1/arg-value-lookups/
Example URI
DELETE /research-common/api/v1/arg-value-lookups/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Arg Value Lookups with MatchingDELETE/research-common/api/v1/arg-value-lookups/
Example URI
DELETE /research-common/api/v1/arg-value-lookups/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Arg Value Lookup Id. Maximum length is 12.
- argumentName
string(optional)Argument Name. Maximum length is 30.
- value
string(optional)Value. Maximum length is 200.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Attachment Files ¶
Get Attachment Files by KeyGET/research-common/api/v1/attachment-files/(key)
Example URI
GET /research-common/api/v1/attachment-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
}Get All Attachment FilesGET/research-common/api/v1/attachment-files/
Example URI
GET /research-common/api/v1/attachment-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
}
]Get All Attachment Files with FilteringGET/research-common/api/v1/attachment-files/
Example URI
GET /research-common/api/v1/attachment-files/
URI Parameters
- id
string(optional)Id. Maximum length is 12.
- sequenceNumber
string(optional)- name
string(optional)File Name. Maximum length is 150.
- type
string(optional)Type. Maximum length is 250.
- data
string(optional)- fileDataId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Attachment FilesGET/research-common/api/v1/attachment-files/
Example URI
GET /research-common/api/v1/attachment-files/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"sequenceNumber",
"name",
"type",
"data",
"fileDataId"
],
"primaryKey": "id"
}Get Blueprint API specification for Attachment FilesGET/research-common/api/v1/attachment-files/
Example URI
GET /research-common/api/v1/attachment-files/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Attachment Files.md"
transfer-encoding: chunkedUpdate Attachment FilesPUT/research-common/api/v1/attachment-files/(key)
Example URI
PUT /research-common/api/v1/attachment-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Attachment FilesPUT/research-common/api/v1/attachment-files/
Example URI
PUT /research-common/api/v1/attachment-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Attachment FilesPATCH/research-common/api/v1/attachment-files/(key)
Example URI
PATCH /research-common/api/v1/attachment-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
}Insert Attachment FilesPOST/research-common/api/v1/attachment-files/
Example URI
POST /research-common/api/v1/attachment-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Attachment FilesPOST/research-common/api/v1/attachment-files/
Example URI
POST /research-common/api/v1/attachment-files/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"type": "(val)",
"data": "(val)",
"fileDataId": "(val)",
"_primaryKey": "(val)"
}
]Delete Attachment Files by KeyDELETE/research-common/api/v1/attachment-files/(key)
Example URI
DELETE /research-common/api/v1/attachment-files/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Attachment FilesDELETE/research-common/api/v1/attachment-files/
Example URI
DELETE /research-common/api/v1/attachment-files/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Attachment Files with MatchingDELETE/research-common/api/v1/attachment-files/
Example URI
DELETE /research-common/api/v1/attachment-files/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Id. Maximum length is 12.
- sequenceNumber
string(optional)- name
string(optional)File Name. Maximum length is 150.
- type
string(optional)Type. Maximum length is 250.
- data
string(optional)- fileDataId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Categories ¶
Get Budget Categories by KeyGET/research-common/api/v1/budget-categories/(key)
Example URI
GET /research-common/api/v1/budget-categories/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Budget CategoriesGET/research-common/api/v1/budget-categories/
Example URI
GET /research-common/api/v1/budget-categories/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Categories with FilteringGET/research-common/api/v1/budget-categories/
Example URI
GET /research-common/api/v1/budget-categories/
URI Parameters
- budgetCategoryTypeCode
string(optional)Category Type. Maximum length is 3.
- code
string(optional)Budget Category Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget CategoriesGET/research-common/api/v1/budget-categories/
Example URI
GET /research-common/api/v1/budget-categories/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetCategoryTypeCode",
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Budget CategoriesGET/research-common/api/v1/budget-categories/
Example URI
GET /research-common/api/v1/budget-categories/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Categories.md"
transfer-encoding: chunkedUpdate Budget CategoriesPUT/research-common/api/v1/budget-categories/(key)
Example URI
PUT /research-common/api/v1/budget-categories/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget CategoriesPUT/research-common/api/v1/budget-categories/
Example URI
PUT /research-common/api/v1/budget-categories/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget CategoriesPATCH/research-common/api/v1/budget-categories/(key)
Example URI
PATCH /research-common/api/v1/budget-categories/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Budget CategoriesPOST/research-common/api/v1/budget-categories/
Example URI
POST /research-common/api/v1/budget-categories/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget CategoriesPOST/research-common/api/v1/budget-categories/
Example URI
POST /research-common/api/v1/budget-categories/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetCategoryTypeCode": "(val)",
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Categories by KeyDELETE/research-common/api/v1/budget-categories/(key)
Example URI
DELETE /research-common/api/v1/budget-categories/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget CategoriesDELETE/research-common/api/v1/budget-categories/
Example URI
DELETE /research-common/api/v1/budget-categories/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Categories with MatchingDELETE/research-common/api/v1/budget-categories/
Example URI
DELETE /research-common/api/v1/budget-categories/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- budgetCategoryTypeCode
string(optional)Category Type. Maximum length is 3.
- code
string(optional)Budget Category Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Category Mappings ¶
Get Budget Category Mappings by KeyGET/research-common/api/v1/budget-category-mappings/(key)
Example URI
GET /research-common/api/v1/budget-category-mappings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
}Get All Budget Category MappingsGET/research-common/api/v1/budget-category-mappings/
Example URI
GET /research-common/api/v1/budget-category-mappings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
},
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Category Mappings with FilteringGET/research-common/api/v1/budget-category-mappings/
Example URI
GET /research-common/api/v1/budget-category-mappings/
URI Parameters
- budgetCategoryCode
string(optional)Budget Category Code. Maximum length is 3.
- mappingName
string(optional)Mapping Name. Maximum length is 100.
- targetCategoryCode
string(optional)Target Category Code. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
},
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Category MappingsGET/research-common/api/v1/budget-category-mappings/
Example URI
GET /research-common/api/v1/budget-category-mappings/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetCategoryCode",
"mappingName",
"targetCategoryCode"
],
"primaryKey": "budgetCategoryCode:mappingName:targetCategoryCode"
}Get Blueprint API specification for Budget Category MappingsGET/research-common/api/v1/budget-category-mappings/
Example URI
GET /research-common/api/v1/budget-category-mappings/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Category Mappings.md"
transfer-encoding: chunkedUpdate Budget Category MappingsPUT/research-common/api/v1/budget-category-mappings/(key)
Example URI
PUT /research-common/api/v1/budget-category-mappings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Category MappingsPUT/research-common/api/v1/budget-category-mappings/
Example URI
PUT /research-common/api/v1/budget-category-mappings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
},
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Category MappingsPATCH/research-common/api/v1/budget-category-mappings/(key)
Example URI
PATCH /research-common/api/v1/budget-category-mappings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
}Insert Budget Category MappingsPOST/research-common/api/v1/budget-category-mappings/
Example URI
POST /research-common/api/v1/budget-category-mappings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Category MappingsPOST/research-common/api/v1/budget-category-mappings/
Example URI
POST /research-common/api/v1/budget-category-mappings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
},
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
},
{
"budgetCategoryCode": "(val)",
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Category Mappings by KeyDELETE/research-common/api/v1/budget-category-mappings/(key)
Example URI
DELETE /research-common/api/v1/budget-category-mappings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Category MappingsDELETE/research-common/api/v1/budget-category-mappings/
Example URI
DELETE /research-common/api/v1/budget-category-mappings/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Category Mappings with MatchingDELETE/research-common/api/v1/budget-category-mappings/
Example URI
DELETE /research-common/api/v1/budget-category-mappings/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- budgetCategoryCode
string(optional)Budget Category Code. Maximum length is 3.
- mappingName
string(optional)Mapping Name. Maximum length is 100.
- targetCategoryCode
string(optional)Target Category Code. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Category Maps ¶
Get Budget Category Maps by KeyGET/research-common/api/v1/budget-category-maps/(key)
Example URI
GET /research-common/api/v1/budget-category-maps/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Budget Category MapsGET/research-common/api/v1/budget-category-maps/
Example URI
GET /research-common/api/v1/budget-category-maps/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Category Maps with FilteringGET/research-common/api/v1/budget-category-maps/
Example URI
GET /research-common/api/v1/budget-category-maps/
URI Parameters
- mappingName
string(optional)Mapping Name. Maximum length is 100.
- targetCategoryCode
string(optional)Target Category Code. Maximum length is 15.
- categoryType
string(optional)Category Type. Maximum length is 200.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Category MapsGET/research-common/api/v1/budget-category-maps/
Example URI
GET /research-common/api/v1/budget-category-maps/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"mappingName",
"targetCategoryCode",
"categoryType",
"description"
],
"primaryKey": "mappingName:targetCategoryCode"
}Get Blueprint API specification for Budget Category MapsGET/research-common/api/v1/budget-category-maps/
Example URI
GET /research-common/api/v1/budget-category-maps/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Category Maps.md"
transfer-encoding: chunkedUpdate Budget Category MapsPUT/research-common/api/v1/budget-category-maps/(key)
Example URI
PUT /research-common/api/v1/budget-category-maps/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Category MapsPUT/research-common/api/v1/budget-category-maps/
Example URI
PUT /research-common/api/v1/budget-category-maps/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Category MapsPATCH/research-common/api/v1/budget-category-maps/(key)
Example URI
PATCH /research-common/api/v1/budget-category-maps/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Budget Category MapsPOST/research-common/api/v1/budget-category-maps/
Example URI
POST /research-common/api/v1/budget-category-maps/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Category MapsPOST/research-common/api/v1/budget-category-maps/
Example URI
POST /research-common/api/v1/budget-category-maps/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mappingName": "(val)",
"targetCategoryCode": "(val)",
"categoryType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Category Maps by KeyDELETE/research-common/api/v1/budget-category-maps/(key)
Example URI
DELETE /research-common/api/v1/budget-category-maps/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Category MapsDELETE/research-common/api/v1/budget-category-maps/
Example URI
DELETE /research-common/api/v1/budget-category-maps/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Category Maps with MatchingDELETE/research-common/api/v1/budget-category-maps/
Example URI
DELETE /research-common/api/v1/budget-category-maps/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- mappingName
string(optional)Mapping Name. Maximum length is 100.
- targetCategoryCode
string(optional)Target Category Code. Maximum length is 15.
- categoryType
string(optional)Category Type. Maximum length is 200.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Category Types ¶
Get Budget Category Types by KeyGET/research-common/api/v1/budget-category-types/(key)
Example URI
GET /research-common/api/v1/budget-category-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Get All Budget Category TypesGET/research-common/api/v1/budget-category-types/
Example URI
GET /research-common/api/v1/budget-category-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Category Types with FilteringGET/research-common/api/v1/budget-category-types/
Example URI
GET /research-common/api/v1/budget-category-types/
URI Parameters
- code
string(optional)Budget Category Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- sortId
string(optional)This sort id is used for sorting budget category. Maximum length is 2.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Category TypesGET/research-common/api/v1/budget-category-types/
Example URI
GET /research-common/api/v1/budget-category-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description",
"sortId"
],
"primaryKey": "code"
}Get Blueprint API specification for Budget Category TypesGET/research-common/api/v1/budget-category-types/
Example URI
GET /research-common/api/v1/budget-category-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Category Types.md"
transfer-encoding: chunkedUpdate Budget Category TypesPUT/research-common/api/v1/budget-category-types/(key)
Example URI
PUT /research-common/api/v1/budget-category-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Category TypesPUT/research-common/api/v1/budget-category-types/
Example URI
PUT /research-common/api/v1/budget-category-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Category TypesPATCH/research-common/api/v1/budget-category-types/(key)
Example URI
PATCH /research-common/api/v1/budget-category-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Insert Budget Category TypesPOST/research-common/api/v1/budget-category-types/
Example URI
POST /research-common/api/v1/budget-category-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Category TypesPOST/research-common/api/v1/budget-category-types/
Example URI
POST /research-common/api/v1/budget-category-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Category Types by KeyDELETE/research-common/api/v1/budget-category-types/(key)
Example URI
DELETE /research-common/api/v1/budget-category-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Category TypesDELETE/research-common/api/v1/budget-category-types/
Example URI
DELETE /research-common/api/v1/budget-category-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Category Types with MatchingDELETE/research-common/api/v1/budget-category-types/
Example URI
DELETE /research-common/api/v1/budget-category-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Budget Category Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- sortId
string(optional)This sort id is used for sorting budget category. Maximum length is 2.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Formulated Cost Details ¶
Get Budget Formulated Cost Details by KeyGET/research-common/api/v1/budget-formulated-cost-details/(key)
Example URI
GET /research-common/api/v1/budget-formulated-cost-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
}Get All Budget Formulated Cost DetailsGET/research-common/api/v1/budget-formulated-cost-details/
Example URI
GET /research-common/api/v1/budget-formulated-cost-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
},
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Formulated Cost Details with FilteringGET/research-common/api/v1/budget-formulated-cost-details/
Example URI
GET /research-common/api/v1/budget-formulated-cost-details/
URI Parameters
- budgetFormulatedCostDetailId
string(optional)Budget Formulated Cost Detail Id. Maximum length is 22.
- formulatedNumber
string(optional)Formulated Number. Maximum length is 22.
- formulatedTypeCode
string(optional)Formulated Type. Maximum length is 50.
- unitCost
string(optional)Unit Cost. Maximum length is 15.
- count
string(optional)Count. Maximum length is 5.
- frequency
string(optional)Frequency. Maximum length is 5.
- calculatedExpenses
string(optional)Calculated Expenses. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
},
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Formulated Cost DetailsGET/research-common/api/v1/budget-formulated-cost-details/
Example URI
GET /research-common/api/v1/budget-formulated-cost-details/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetFormulatedCostDetailId",
"formulatedNumber",
"formulatedTypeCode",
"unitCost",
"count",
"frequency",
"calculatedExpenses"
],
"primaryKey": "budgetFormulatedCostDetailId"
}Get Blueprint API specification for Budget Formulated Cost DetailsGET/research-common/api/v1/budget-formulated-cost-details/
Example URI
GET /research-common/api/v1/budget-formulated-cost-details/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Formulated Cost Details.md"
transfer-encoding: chunkedUpdate Budget Formulated Cost DetailsPUT/research-common/api/v1/budget-formulated-cost-details/(key)
Example URI
PUT /research-common/api/v1/budget-formulated-cost-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Formulated Cost DetailsPUT/research-common/api/v1/budget-formulated-cost-details/
Example URI
PUT /research-common/api/v1/budget-formulated-cost-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
},
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Formulated Cost DetailsPATCH/research-common/api/v1/budget-formulated-cost-details/(key)
Example URI
PATCH /research-common/api/v1/budget-formulated-cost-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
}Insert Budget Formulated Cost DetailsPOST/research-common/api/v1/budget-formulated-cost-details/
Example URI
POST /research-common/api/v1/budget-formulated-cost-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Formulated Cost DetailsPOST/research-common/api/v1/budget-formulated-cost-details/
Example URI
POST /research-common/api/v1/budget-formulated-cost-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
},
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
},
{
"budgetFormulatedCostDetailId": "(val)",
"formulatedNumber": "(val)",
"formulatedTypeCode": "(val)",
"unitCost": "(val)",
"count": "(val)",
"frequency": "(val)",
"calculatedExpenses": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Formulated Cost Details by KeyDELETE/research-common/api/v1/budget-formulated-cost-details/(key)
Example URI
DELETE /research-common/api/v1/budget-formulated-cost-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Formulated Cost DetailsDELETE/research-common/api/v1/budget-formulated-cost-details/
Example URI
DELETE /research-common/api/v1/budget-formulated-cost-details/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Formulated Cost Details with MatchingDELETE/research-common/api/v1/budget-formulated-cost-details/
Example URI
DELETE /research-common/api/v1/budget-formulated-cost-details/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- budgetFormulatedCostDetailId
string(optional)Budget Formulated Cost Detail Id. Maximum length is 22.
- formulatedNumber
string(optional)Formulated Number. Maximum length is 22.
- formulatedTypeCode
string(optional)Formulated Type. Maximum length is 50.
- unitCost
string(optional)Unit Cost. Maximum length is 15.
- count
string(optional)Count. Maximum length is 5.
- frequency
string(optional)Frequency. Maximum length is 5.
- calculatedExpenses
string(optional)Calculated Expenses. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget La Rates ¶
Get Budget La Rates by KeyGET/research-common/api/v1/budget-la-rates/(key)
Example URI
GET /research-common/api/v1/budget-la-rates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"applicableRate": "(val)",
"instituteRate": "(val)",
"onOffCampusFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Get All Budget La RatesGET/research-common/api/v1/budget-la-rates/
Example URI
GET /research-common/api/v1/budget-la-rates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"applicableRate": "(val)",
"instituteRate": "(val)",
"onOffCampusFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"applicableRate": "(val)",
"instituteRate": "(val)",
"onOffCampusFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget La Rates with FilteringGET/research-common/api/v1/budget-la-rates/
Example URI
GET /research-common/api/v1/budget-la-rates/
URI Parameters
- applicableRate
string(optional)- instituteRate
string(optional)- onOffCampusFlag
string(optional)- rateTypeCode
string(optional)- budgetId
string(optional)- rateClassCode
string(optional)- fiscalYear
string(optional)- startDate
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"applicableRate": "(val)",
"instituteRate": "(val)",
"onOffCampusFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"applicableRate": "(val)",
"instituteRate": "(val)",
"onOffCampusFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget La RatesGET/research-common/api/v1/budget-la-rates/
Example URI
GET /research-common/api/v1/budget-la-rates/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"applicableRate",
"instituteRate",
"onOffCampusFlag",
"rateTypeCode",
"budgetId",
"rateClassCode",
"fiscalYear",
"startDate"
],
"primaryKey": "budget:budgetId"
}Get Blueprint API specification for Budget La RatesGET/research-common/api/v1/budget-la-rates/
Example URI
GET /research-common/api/v1/budget-la-rates/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget La Rates.md"
transfer-encoding: chunkedBudget Line Item Calculated Amounts ¶
Get Budget Line Item Calculated Amounts by KeyGET/research-common/api/v1/budget-line-item-calculated-amounts/(key)
Example URI
GET /research-common/api/v1/budget-line-item-calculated-amounts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}Get All Budget Line Item Calculated AmountsGET/research-common/api/v1/budget-line-item-calculated-amounts/
Example URI
GET /research-common/api/v1/budget-line-item-calculated-amounts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
},
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Line Item Calculated Amounts with FilteringGET/research-common/api/v1/budget-line-item-calculated-amounts/
Example URI
GET /research-common/api/v1/budget-line-item-calculated-amounts/
URI Parameters
- budgetLineItemCalculatedAmountId
string(optional)Budget Line Item Calculated Amount Id.
- budgetLineItemId
string(optional)Budget Line Item Id.
- budgetPeriodId
string(optional)Budget Period Id.
- rateTypeDescription
string(optional)Rate Type Description.
- applyRateFlag
string(optional)Apply Rate?. Maximum length is 1.
- rateTypeCode
string(optional)Rate Type. Maximum length is 3.
- budgetId
string(optional)Budget Id.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- calculatedCost
string(optional)Rate Cost. Maximum length is 15.
- rateClassCode
string(optional)Rate Class. Maximum length is 3.
- calculatedCostSharing
string(optional)Rate Cost Sharing. Maximum length is 15.
- lineItemNumber
string(optional)Line Item Number. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
},
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Line Item Calculated AmountsGET/research-common/api/v1/budget-line-item-calculated-amounts/
Example URI
GET /research-common/api/v1/budget-line-item-calculated-amounts/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetLineItemCalculatedAmountId",
"budgetLineItemId",
"budgetPeriodId",
"rateTypeDescription",
"applyRateFlag",
"rateTypeCode",
"budgetId",
"budgetPeriod",
"calculatedCost",
"rateClassCode",
"calculatedCostSharing",
"lineItemNumber"
],
"primaryKey": "budgetLineItemCalculatedAmountId"
}Get Blueprint API specification for Budget Line Item Calculated AmountsGET/research-common/api/v1/budget-line-item-calculated-amounts/
Example URI
GET /research-common/api/v1/budget-line-item-calculated-amounts/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Line Item Calculated Amounts.md"
transfer-encoding: chunkedUpdate Budget Line Item Calculated AmountsPUT/research-common/api/v1/budget-line-item-calculated-amounts/(key)
Example URI
PUT /research-common/api/v1/budget-line-item-calculated-amounts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Line Item Calculated AmountsPUT/research-common/api/v1/budget-line-item-calculated-amounts/
Example URI
PUT /research-common/api/v1/budget-line-item-calculated-amounts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
},
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Line Item Calculated AmountsPATCH/research-common/api/v1/budget-line-item-calculated-amounts/(key)
Example URI
PATCH /research-common/api/v1/budget-line-item-calculated-amounts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}Insert Budget Line Item Calculated AmountsPOST/research-common/api/v1/budget-line-item-calculated-amounts/
Example URI
POST /research-common/api/v1/budget-line-item-calculated-amounts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Line Item Calculated AmountsPOST/research-common/api/v1/budget-line-item-calculated-amounts/
Example URI
POST /research-common/api/v1/budget-line-item-calculated-amounts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
},
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
},
{
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Line Item Calculated Amounts by KeyDELETE/research-common/api/v1/budget-line-item-calculated-amounts/(key)
Example URI
DELETE /research-common/api/v1/budget-line-item-calculated-amounts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Line Item Calculated AmountsDELETE/research-common/api/v1/budget-line-item-calculated-amounts/
Example URI
DELETE /research-common/api/v1/budget-line-item-calculated-amounts/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Line Item Calculated Amounts with MatchingDELETE/research-common/api/v1/budget-line-item-calculated-amounts/
Example URI
DELETE /research-common/api/v1/budget-line-item-calculated-amounts/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- budgetLineItemCalculatedAmountId
string(optional)Budget Line Item Calculated Amount Id.
- budgetLineItemId
string(optional)Budget Line Item Id.
- budgetPeriodId
string(optional)Budget Period Id.
- rateTypeDescription
string(optional)Rate Type Description.
- applyRateFlag
string(optional)Apply Rate?. Maximum length is 1.
- rateTypeCode
string(optional)Rate Type. Maximum length is 3.
- budgetId
string(optional)Budget Id.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- calculatedCost
string(optional)Rate Cost. Maximum length is 15.
- rateClassCode
string(optional)Rate Class. Maximum length is 3.
- calculatedCostSharing
string(optional)Rate Cost Sharing. Maximum length is 15.
- lineItemNumber
string(optional)Line Item Number. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Line Items ¶
Get Budget Line Items by KeyGET/research-common/api/v1/budget-line-items/(key)
Example URI
GET /research-common/api/v1/budget-line-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Get All Budget Line ItemsGET/research-common/api/v1/budget-line-items/
Example URI
GET /research-common/api/v1/budget-line-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Line Items with FilteringGET/research-common/api/v1/budget-line-items/
Example URI
GET /research-common/api/v1/budget-line-items/
URI Parameters
- costSharingAmount
string(optional)Cost Sharing. Maximum length is 15.
- budgetLineItemId
string(optional)Budget Line Item Id.
- budgetPeriodId
string(optional)Budget Period Id. Maximum length is 3.
- lineItemNumber
string(optional)Line Item Number. Maximum length is 6.
- budgetId
string(optional)Budget Id.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- applyInRateFlag
string(optional)Apply Inflation?. Maximum length is 1.
- basedOnLineItem
string(optional)Based On Line Item. Maximum length is 6.
- budgetCategoryCode
string(optional)Budget Category. Maximum length is 3.
- budgetJustification
string(optional)Budget Justification Notes. Maximum length is 200.
- costElement
string(optional)Object Code Name. Maximum length is 8.
- groupName
string(optional)Group. Maximum length is 80.
- endDate
string(optional)End Date. Maximum length is 21.
- lineItemCost
string(optional)Total Base Cost. Maximum length is 15.
- lineItemDescription
string(optional)Description. Maximum length is 80.
- lineItemSequence
string(optional)Line Item Sequence. Maximum length is 6.
- onOffCampusFlag
string(optional)On CampusContract?. Maximum length is 1.
- quantity
string(optional)Quantity. Maximum length is 4.
- startDate
string(optional)Start Date. Maximum length is 21.
- underrecoveryAmount
string(optional)Unrecovered F&A. Maximum length is 15.
- submitCostSharingFlag
string(optional)Submit Cost Sharing Flag. Maximum length is 1.
- formulatedCostElementFlag
string(optional)Formulated Cost Element Flag.
- subAwardNumber
string(optional)Sub Award Number.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Line ItemsGET/research-common/api/v1/budget-line-items/
Example URI
GET /research-common/api/v1/budget-line-items/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"costSharingAmount",
"budgetLineItemId",
"budgetPeriodId",
"lineItemNumber",
"budgetId",
"budgetPeriod",
"applyInRateFlag",
"basedOnLineItem",
"budgetCategoryCode",
"budgetJustification",
"costElement",
"groupName",
"endDate",
"lineItemCost",
"lineItemDescription",
"lineItemSequence",
"onOffCampusFlag",
"quantity",
"startDate",
"underrecoveryAmount",
"submitCostSharingFlag",
"formulatedCostElementFlag",
"subAwardNumber",
"hierarchyProposalNumber",
"hiddenInHierarchy"
],
"primaryKey": "budgetLineItemId"
}Get Blueprint API specification for Budget Line ItemsGET/research-common/api/v1/budget-line-items/
Example URI
GET /research-common/api/v1/budget-line-items/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Line Items.md"
transfer-encoding: chunkedUpdate Budget Line ItemsPUT/research-common/api/v1/budget-line-items/(key)
Example URI
PUT /research-common/api/v1/budget-line-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Line ItemsPUT/research-common/api/v1/budget-line-items/
Example URI
PUT /research-common/api/v1/budget-line-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Line ItemsPATCH/research-common/api/v1/budget-line-items/(key)
Example URI
PATCH /research-common/api/v1/budget-line-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert Budget Line ItemsPOST/research-common/api/v1/budget-line-items/
Example URI
POST /research-common/api/v1/budget-line-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Line ItemsPOST/research-common/api/v1/budget-line-items/
Example URI
POST /research-common/api/v1/budget-line-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"costSharingAmount": "(val)",
"budgetLineItemId": "(val)",
"budgetPeriodId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"applyInRateFlag": "(val)",
"basedOnLineItem": "(val)",
"budgetCategoryCode": "(val)",
"budgetJustification": "(val)",
"costElement": "(val)",
"groupName": "(val)",
"endDate": "(val)",
"lineItemCost": "(val)",
"lineItemDescription": "(val)",
"lineItemSequence": "(val)",
"onOffCampusFlag": "(val)",
"quantity": "(val)",
"startDate": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"formulatedCostElementFlag": "(val)",
"subAwardNumber": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Line Items by KeyDELETE/research-common/api/v1/budget-line-items/(key)
Example URI
DELETE /research-common/api/v1/budget-line-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Line ItemsDELETE/research-common/api/v1/budget-line-items/
Example URI
DELETE /research-common/api/v1/budget-line-items/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Line Items with MatchingDELETE/research-common/api/v1/budget-line-items/
Example URI
DELETE /research-common/api/v1/budget-line-items/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- costSharingAmount
string(optional)Cost Sharing. Maximum length is 15.
- budgetLineItemId
string(optional)Budget Line Item Id.
- budgetPeriodId
string(optional)Budget Period Id. Maximum length is 3.
- lineItemNumber
string(optional)Line Item Number. Maximum length is 6.
- budgetId
string(optional)Budget Id.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- applyInRateFlag
string(optional)Apply Inflation?. Maximum length is 1.
- basedOnLineItem
string(optional)Based On Line Item. Maximum length is 6.
- budgetCategoryCode
string(optional)Budget Category. Maximum length is 3.
- budgetJustification
string(optional)Budget Justification Notes. Maximum length is 200.
- costElement
string(optional)Object Code Name. Maximum length is 8.
- groupName
string(optional)Group. Maximum length is 80.
- endDate
string(optional)End Date. Maximum length is 21.
- lineItemCost
string(optional)Total Base Cost. Maximum length is 15.
- lineItemDescription
string(optional)Description. Maximum length is 80.
- lineItemSequence
string(optional)Line Item Sequence. Maximum length is 6.
- onOffCampusFlag
string(optional)On CampusContract?. Maximum length is 1.
- quantity
string(optional)Quantity. Maximum length is 4.
- startDate
string(optional)Start Date. Maximum length is 21.
- underrecoveryAmount
string(optional)Unrecovered F&A. Maximum length is 15.
- submitCostSharingFlag
string(optional)Submit Cost Sharing Flag. Maximum length is 1.
- formulatedCostElementFlag
string(optional)Formulated Cost Element Flag.
- subAwardNumber
string(optional)Sub Award Number.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Period Types ¶
Get Budget Period Types by KeyGET/research-common/api/v1/budget-period-types/(key)
Example URI
GET /research-common/api/v1/budget-period-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Budget Period TypesGET/research-common/api/v1/budget-period-types/
Example URI
GET /research-common/api/v1/budget-period-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Period Types with FilteringGET/research-common/api/v1/budget-period-types/
Example URI
GET /research-common/api/v1/budget-period-types/
URI Parameters
- budgetPeriodTypeCode
string(optional)Budget Period Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Period TypesGET/research-common/api/v1/budget-period-types/
Example URI
GET /research-common/api/v1/budget-period-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetPeriodTypeCode",
"description"
],
"primaryKey": "budgetPeriodTypeCode"
}Get Blueprint API specification for Budget Period TypesGET/research-common/api/v1/budget-period-types/
Example URI
GET /research-common/api/v1/budget-period-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Period Types.md"
transfer-encoding: chunkedUpdate Budget Period TypesPUT/research-common/api/v1/budget-period-types/(key)
Example URI
PUT /research-common/api/v1/budget-period-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Period TypesPUT/research-common/api/v1/budget-period-types/
Example URI
PUT /research-common/api/v1/budget-period-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Period TypesPATCH/research-common/api/v1/budget-period-types/(key)
Example URI
PATCH /research-common/api/v1/budget-period-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Budget Period TypesPOST/research-common/api/v1/budget-period-types/
Example URI
POST /research-common/api/v1/budget-period-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Period TypesPOST/research-common/api/v1/budget-period-types/
Example URI
POST /research-common/api/v1/budget-period-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Period Types by KeyDELETE/research-common/api/v1/budget-period-types/(key)
Example URI
DELETE /research-common/api/v1/budget-period-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Period TypesDELETE/research-common/api/v1/budget-period-types/
Example URI
DELETE /research-common/api/v1/budget-period-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Period Types with MatchingDELETE/research-common/api/v1/budget-period-types/
Example URI
DELETE /research-common/api/v1/budget-period-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- budgetPeriodTypeCode
string(optional)Budget Period Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Periods ¶
Get Budget Periods by KeyGET/research-common/api/v1/budget-periods/(key)
Example URI
GET /research-common/api/v1/budget-periods/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"comments": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"numberOfParticipants": "(val)",
"directCostLimit": "(val)",
"_primaryKey": "(val)"
}Get All Budget PeriodsGET/research-common/api/v1/budget-periods/
Example URI
GET /research-common/api/v1/budget-periods/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"comments": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"numberOfParticipants": "(val)",
"directCostLimit": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"comments": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"numberOfParticipants": "(val)",
"directCostLimit": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Periods with FilteringGET/research-common/api/v1/budget-periods/
Example URI
GET /research-common/api/v1/budget-periods/
URI Parameters
- budgetPeriodId
string(optional)Budget Period Id. Maximum length is 12.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- comments
string(optional)Comments. Maximum length is 2000.
- costSharingAmount
string(optional)Cost Sharing. Maximum length is 15.
- endDate
string(optional)Period End Date. Maximum length is 21.
- startDate
string(optional)Period Start Date. Maximum length is 21.
- totalCost
string(optional)Total Sponsor Cost. Maximum length is 15.
- totalCostLimit
string(optional)Cost Limit. Maximum length is 15.
- totalDirectCost
string(optional)Direct Cost. Maximum length is 15.
- totalIndirectCost
string(optional)F&A Cost. Maximum length is 15.
- underrecoveryAmount
string(optional)Unrecovered F&A. Maximum length is 15.
- numberOfParticipants
string(optional)Number of Participants. Maximum length is 6.
- directCostLimit
string(optional)Direct Cost Limit. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"comments": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"numberOfParticipants": "(val)",
"directCostLimit": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPeriodId": "(val)",
"budgetPeriod": "(val)",
"comments": "(val)",
"costSharingAmount": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"totalCostLimit": "(val)",
"totalDirectCost": "(val)",
"totalIndirectCost": "(val)",
"underrecoveryAmount": "(val)",
"numberOfParticipants": "(val)",
"directCostLimit": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget PeriodsGET/research-common/api/v1/budget-periods/
Example URI
GET /research-common/api/v1/budget-periods/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetPeriodId",
"budgetPeriod",
"comments",
"costSharingAmount",
"endDate",
"startDate",
"totalCost",
"totalCostLimit",
"totalDirectCost",
"totalIndirectCost",
"underrecoveryAmount",
"numberOfParticipants",
"directCostLimit"
],
"primaryKey": "budgetPeriodId"
}Get Blueprint API specification for Budget PeriodsGET/research-common/api/v1/budget-periods/
Example URI
GET /research-common/api/v1/budget-periods/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Periods.md"
transfer-encoding: chunkedBudget Person Salary Details ¶
Get Budget Person Salary Details by KeyGET/research-common/api/v1/budget-person-salary-details/(key)
Example URI
GET /research-common/api/v1/budget-person-salary-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
}Get All Budget Person Salary DetailsGET/research-common/api/v1/budget-person-salary-details/
Example URI
GET /research-common/api/v1/budget-person-salary-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Person Salary Details with FilteringGET/research-common/api/v1/budget-person-salary-details/
Example URI
GET /research-common/api/v1/budget-person-salary-details/
URI Parameters
- budgetPersonSalaryDetailId
string(optional)Budget Person Salary Detail Id. Maximum length is 22.
- personSequenceNumber
string(optional)Person. Maximum length is 9.
- budgetId
string(optional)Budget Id. Maximum length is 22.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- personId
string(optional)Person Id.
- baseSalary
string(optional)Salary. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Person Salary DetailsGET/research-common/api/v1/budget-person-salary-details/
Example URI
GET /research-common/api/v1/budget-person-salary-details/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetPersonSalaryDetailId",
"personSequenceNumber",
"budgetId",
"budgetPeriod",
"personId",
"baseSalary"
],
"primaryKey": "budgetPersonSalaryDetailId"
}Get Blueprint API specification for Budget Person Salary DetailsGET/research-common/api/v1/budget-person-salary-details/
Example URI
GET /research-common/api/v1/budget-person-salary-details/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Person Salary Details.md"
transfer-encoding: chunkedUpdate Budget Person Salary DetailsPUT/research-common/api/v1/budget-person-salary-details/(key)
Example URI
PUT /research-common/api/v1/budget-person-salary-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Person Salary DetailsPUT/research-common/api/v1/budget-person-salary-details/
Example URI
PUT /research-common/api/v1/budget-person-salary-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Person Salary DetailsPATCH/research-common/api/v1/budget-person-salary-details/(key)
Example URI
PATCH /research-common/api/v1/budget-person-salary-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
}Insert Budget Person Salary DetailsPOST/research-common/api/v1/budget-person-salary-details/
Example URI
POST /research-common/api/v1/budget-person-salary-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Person Salary DetailsPOST/research-common/api/v1/budget-person-salary-details/
Example URI
POST /research-common/api/v1/budget-person-salary-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonSalaryDetailId": "(val)",
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"personId": "(val)",
"baseSalary": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Person Salary Details by KeyDELETE/research-common/api/v1/budget-person-salary-details/(key)
Example URI
DELETE /research-common/api/v1/budget-person-salary-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Person Salary DetailsDELETE/research-common/api/v1/budget-person-salary-details/
Example URI
DELETE /research-common/api/v1/budget-person-salary-details/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Person Salary Details with MatchingDELETE/research-common/api/v1/budget-person-salary-details/
Example URI
DELETE /research-common/api/v1/budget-person-salary-details/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- budgetPersonSalaryDetailId
string(optional)Budget Person Salary Detail Id. Maximum length is 22.
- personSequenceNumber
string(optional)Person. Maximum length is 9.
- budgetId
string(optional)Budget Id. Maximum length is 22.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- personId
string(optional)Person Id.
- baseSalary
string(optional)Salary. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Personnel Calculated Amounts ¶
Get Budget Personnel Calculated Amounts by KeyGET/research-common/api/v1/budget-personnel-calculated-amounts/(key)
Example URI
GET /research-common/api/v1/budget-personnel-calculated-amounts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}Get All Budget Personnel Calculated AmountsGET/research-common/api/v1/budget-personnel-calculated-amounts/
Example URI
GET /research-common/api/v1/budget-personnel-calculated-amounts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
},
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Personnel Calculated Amounts with FilteringGET/research-common/api/v1/budget-personnel-calculated-amounts/
Example URI
GET /research-common/api/v1/budget-personnel-calculated-amounts/
URI Parameters
- personNumber
string(optional)Person Number. Maximum length is 3.
- budgetPersonnelCalculatedAmountId
string(optional)Budget Personnel Calculated Amount Id.
- budgetPersonnelLineItemId
string(optional)Budget Personnel Line Item Id.
- budgetPeriodId
string(optional)Budget Period Id.
- rateTypeDescription
string(optional)Rate Type Description.
- applyRateFlag
string(optional)Apply Rate?. Maximum length is 1.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
- budgetId
string(optional)Budget Id.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- calculatedCost
string(optional)Calculated Cost. Maximum length is 15.
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- calculatedCostSharing
string(optional)Calculated Cost Sharing. Maximum length is 15.
- lineItemNumber
string(optional)Line Item Number. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
},
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Personnel Calculated AmountsGET/research-common/api/v1/budget-personnel-calculated-amounts/
Example URI
GET /research-common/api/v1/budget-personnel-calculated-amounts/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"personNumber",
"budgetPersonnelCalculatedAmountId",
"budgetPersonnelLineItemId",
"budgetPeriodId",
"rateTypeDescription",
"applyRateFlag",
"rateTypeCode",
"budgetId",
"budgetPeriod",
"calculatedCost",
"rateClassCode",
"calculatedCostSharing",
"lineItemNumber"
],
"primaryKey": "budgetPersonnelCalculatedAmountId"
}Get Blueprint API specification for Budget Personnel Calculated AmountsGET/research-common/api/v1/budget-personnel-calculated-amounts/
Example URI
GET /research-common/api/v1/budget-personnel-calculated-amounts/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Personnel Calculated Amounts.md"
transfer-encoding: chunkedUpdate Budget Personnel Calculated AmountsPUT/research-common/api/v1/budget-personnel-calculated-amounts/(key)
Example URI
PUT /research-common/api/v1/budget-personnel-calculated-amounts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Personnel Calculated AmountsPUT/research-common/api/v1/budget-personnel-calculated-amounts/
Example URI
PUT /research-common/api/v1/budget-personnel-calculated-amounts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
},
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Personnel Calculated AmountsPATCH/research-common/api/v1/budget-personnel-calculated-amounts/(key)
Example URI
PATCH /research-common/api/v1/budget-personnel-calculated-amounts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}Insert Budget Personnel Calculated AmountsPOST/research-common/api/v1/budget-personnel-calculated-amounts/
Example URI
POST /research-common/api/v1/budget-personnel-calculated-amounts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Personnel Calculated AmountsPOST/research-common/api/v1/budget-personnel-calculated-amounts/
Example URI
POST /research-common/api/v1/budget-personnel-calculated-amounts/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
},
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
},
{
"personNumber": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"budgetPeriodId": "(val)",
"rateTypeDescription": "(val)",
"applyRateFlag": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Personnel Calculated Amounts by KeyDELETE/research-common/api/v1/budget-personnel-calculated-amounts/(key)
Example URI
DELETE /research-common/api/v1/budget-personnel-calculated-amounts/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Personnel Calculated AmountsDELETE/research-common/api/v1/budget-personnel-calculated-amounts/
Example URI
DELETE /research-common/api/v1/budget-personnel-calculated-amounts/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Personnel Calculated Amounts with MatchingDELETE/research-common/api/v1/budget-personnel-calculated-amounts/
Example URI
DELETE /research-common/api/v1/budget-personnel-calculated-amounts/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- personNumber
string(optional)Person Number. Maximum length is 3.
- budgetPersonnelCalculatedAmountId
string(optional)Budget Personnel Calculated Amount Id.
- budgetPersonnelLineItemId
string(optional)Budget Personnel Line Item Id.
- budgetPeriodId
string(optional)Budget Period Id.
- rateTypeDescription
string(optional)Rate Type Description.
- applyRateFlag
string(optional)Apply Rate?. Maximum length is 1.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
- budgetId
string(optional)Budget Id.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- calculatedCost
string(optional)Calculated Cost. Maximum length is 15.
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- calculatedCostSharing
string(optional)Calculated Cost Sharing. Maximum length is 15.
- lineItemNumber
string(optional)Line Item Number. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Personnel Details ¶
Get Budget Personnel Details by KeyGET/research-common/api/v1/budget-personnel-details/(key)
Example URI
GET /research-common/api/v1/budget-personnel-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}Get All Budget Personnel DetailsGET/research-common/api/v1/budget-personnel-details/
Example URI
GET /research-common/api/v1/budget-personnel-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Personnel Details with FilteringGET/research-common/api/v1/budget-personnel-details/
Example URI
GET /research-common/api/v1/budget-personnel-details/
URI Parameters
- budgetPersonnelLineItemId
string(optional)Budget Personnel Line Item Id.
- budgetLineItemId
string(optional)Budget Line Item Id.
- lineItemNumber
string(optional)Line Item Number. Maximum length is 6.
- budgetId
string(optional)Budget Id.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- onOffCampusFlag
string(optional)On Off CampusContractContract Flag. Maximum length is 1.
- endDate
string(optional)End Date. Maximum length is 21.
- startDate
string(optional)Start Date. Maximum length is 21.
- budgetJustification
string(optional)Budget Justification. Maximum length is 0.
- costSharingAmount
string(optional)Cost Sharing Amount. Maximum length is 15.
- lineItemDescription
string(optional)Description. Maximum length is 80.
- applyInRateFlag
string(optional)Apply In Rate Flag. Maximum length is 1.
- personNumber
string(optional)Person Number. Maximum length is 3.
- costSharingPercent
string(optional)Cost Sharing Percent. Maximum length is 7.
- jobCode
string(optional)Job Code. Maximum length is 6.
- percentCharged
string(optional)% Charged. Maximum length is 6.
- percentEffort
string(optional)% Effort. Maximum length is 6.
- periodTypeCode
string(optional)Period Type. Maximum length is 3.
- personId
string(optional)KcPerson Id. Maximum length is 40.
- salaryRequested
string(optional)Requested Salary. Maximum length is 15.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 6.
- budgetPeriodId
string(optional)Budget Period Id.
- personSequenceNumber
string(optional)Person. Maximum length is 9.
- underrecoveryAmount
string(optional)Unrecovered F&A. Maximum length is 15.
- submitCostSharingFlag
string(optional)Submit Cost Sharing Flag.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Personnel DetailsGET/research-common/api/v1/budget-personnel-details/
Example URI
GET /research-common/api/v1/budget-personnel-details/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetPersonnelLineItemId",
"budgetLineItemId",
"lineItemNumber",
"budgetId",
"budgetPeriod",
"onOffCampusFlag",
"endDate",
"startDate",
"budgetJustification",
"costSharingAmount",
"lineItemDescription",
"applyInRateFlag",
"personNumber",
"costSharingPercent",
"jobCode",
"percentCharged",
"percentEffort",
"periodTypeCode",
"personId",
"salaryRequested",
"sequenceNumber",
"budgetPeriodId",
"personSequenceNumber",
"underrecoveryAmount",
"submitCostSharingFlag"
],
"primaryKey": "budgetPersonnelLineItemId"
}Get Blueprint API specification for Budget Personnel DetailsGET/research-common/api/v1/budget-personnel-details/
Example URI
GET /research-common/api/v1/budget-personnel-details/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Personnel Details.md"
transfer-encoding: chunkedUpdate Budget Personnel DetailsPUT/research-common/api/v1/budget-personnel-details/(key)
Example URI
PUT /research-common/api/v1/budget-personnel-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Personnel DetailsPUT/research-common/api/v1/budget-personnel-details/
Example URI
PUT /research-common/api/v1/budget-personnel-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Personnel DetailsPATCH/research-common/api/v1/budget-personnel-details/(key)
Example URI
PATCH /research-common/api/v1/budget-personnel-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}Insert Budget Personnel DetailsPOST/research-common/api/v1/budget-personnel-details/
Example URI
POST /research-common/api/v1/budget-personnel-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Personnel DetailsPOST/research-common/api/v1/budget-personnel-details/
Example URI
POST /research-common/api/v1/budget-personnel-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonnelLineItemId": "(val)",
"budgetLineItemId": "(val)",
"lineItemNumber": "(val)",
"budgetId": "(val)",
"budgetPeriod": "(val)",
"onOffCampusFlag": "(val)",
"endDate": "(val)",
"startDate": "(val)",
"budgetJustification": "(val)",
"costSharingAmount": "(val)",
"lineItemDescription": "(val)",
"applyInRateFlag": "(val)",
"personNumber": "(val)",
"costSharingPercent": "(val)",
"jobCode": "(val)",
"percentCharged": "(val)",
"percentEffort": "(val)",
"periodTypeCode": "(val)",
"personId": "(val)",
"salaryRequested": "(val)",
"sequenceNumber": "(val)",
"budgetPeriodId": "(val)",
"personSequenceNumber": "(val)",
"underrecoveryAmount": "(val)",
"submitCostSharingFlag": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Personnel Details by KeyDELETE/research-common/api/v1/budget-personnel-details/(key)
Example URI
DELETE /research-common/api/v1/budget-personnel-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Personnel DetailsDELETE/research-common/api/v1/budget-personnel-details/
Example URI
DELETE /research-common/api/v1/budget-personnel-details/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Personnel Details with MatchingDELETE/research-common/api/v1/budget-personnel-details/
Example URI
DELETE /research-common/api/v1/budget-personnel-details/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- budgetPersonnelLineItemId
string(optional)Budget Personnel Line Item Id.
- budgetLineItemId
string(optional)Budget Line Item Id.
- lineItemNumber
string(optional)Line Item Number. Maximum length is 6.
- budgetId
string(optional)Budget Id.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- onOffCampusFlag
string(optional)On Off CampusContractContract Flag. Maximum length is 1.
- endDate
string(optional)End Date. Maximum length is 21.
- startDate
string(optional)Start Date. Maximum length is 21.
- budgetJustification
string(optional)Budget Justification. Maximum length is 0.
- costSharingAmount
string(optional)Cost Sharing Amount. Maximum length is 15.
- lineItemDescription
string(optional)Description. Maximum length is 80.
- applyInRateFlag
string(optional)Apply In Rate Flag. Maximum length is 1.
- personNumber
string(optional)Person Number. Maximum length is 3.
- costSharingPercent
string(optional)Cost Sharing Percent. Maximum length is 7.
- jobCode
string(optional)Job Code. Maximum length is 6.
- percentCharged
string(optional)% Charged. Maximum length is 6.
- percentEffort
string(optional)% Effort. Maximum length is 6.
- periodTypeCode
string(optional)Period Type. Maximum length is 3.
- personId
string(optional)KcPerson Id. Maximum length is 40.
- salaryRequested
string(optional)Requested Salary. Maximum length is 15.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 6.
- budgetPeriodId
string(optional)Budget Period Id.
- personSequenceNumber
string(optional)Person. Maximum length is 9.
- underrecoveryAmount
string(optional)Unrecovered F&A. Maximum length is 15.
- submitCostSharingFlag
string(optional)Submit Cost Sharing Flag.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Personnel Rate And Bases ¶
Get Budget Personnel Rate And Bases by KeyGET/research-common/api/v1/budget-personnel-rate-and-bases/(key)
Example URI
GET /research-common/api/v1/budget-personnel-rate-and-bases/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Get All Budget Personnel Rate And BasesGET/research-common/api/v1/budget-personnel-rate-and-bases/
Example URI
GET /research-common/api/v1/budget-personnel-rate-and-bases/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Personnel Rate And Bases with FilteringGET/research-common/api/v1/budget-personnel-rate-and-bases/
Example URI
GET /research-common/api/v1/budget-personnel-rate-and-bases/
URI Parameters
- budgetPersonnelRateAndBaseId
string(optional)Budget Personnel Rate And Base Id.
- budgetPersonnelCalculatedAmountId
string(optional)Budget Personnel Calculated Amount Id.
- budgetPersonnelLineItemId
string(optional)Budget Personnel Line Item Id.
- personId
string(optional)KcPerson Id. Maximum length is 40.
- personNumber
string(optional)Person Number.
- salaryRequested
string(optional)Salary Requested. Maximum length is 15.
- baseCostSharing
string(optional)Base Cost Sharing. Maximum length is 15.
- budgetPeriodId
string(optional)Budget Period Id.
- endDate
string(optional)End Date. Maximum length is 21.
- rateTypeCode
string(optional)Rate Type. Maximum length is 3.
- budgetId
string(optional)Budget Id.
- rateNumber
string(optional)Rate Number. Maximum length is 3.
- appliedRate
string(optional)Applied Rate. Maximum length is 7.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- calculatedCost
string(optional)Calculated Cost. Maximum length is 15.
- onOffCampusFlag
string(optional)On CampusContract?. Maximum length is 1.
- rateClassCode
string(optional)Rate Class. Maximum length is 3.
- calculatedCostSharing
string(optional)Calculated Cost Sharing. Maximum length is 15.
- lineItemNumber
string(optional)Line Item Number. Maximum length is 6.
- startDate
string(optional)Start Date. Maximum length is 21.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Personnel Rate And BasesGET/research-common/api/v1/budget-personnel-rate-and-bases/
Example URI
GET /research-common/api/v1/budget-personnel-rate-and-bases/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"budgetPersonnelRateAndBaseId",
"budgetPersonnelCalculatedAmountId",
"budgetPersonnelLineItemId",
"personId",
"personNumber",
"salaryRequested",
"baseCostSharing",
"budgetPeriodId",
"endDate",
"rateTypeCode",
"budgetId",
"rateNumber",
"appliedRate",
"budgetPeriod",
"calculatedCost",
"onOffCampusFlag",
"rateClassCode",
"calculatedCostSharing",
"lineItemNumber",
"startDate"
],
"primaryKey": "budgetPersonnelRateAndBaseId"
}Get Blueprint API specification for Budget Personnel Rate And BasesGET/research-common/api/v1/budget-personnel-rate-and-bases/
Example URI
GET /research-common/api/v1/budget-personnel-rate-and-bases/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Personnel Rate And Bases.md"
transfer-encoding: chunkedUpdate Budget Personnel Rate And BasesPUT/research-common/api/v1/budget-personnel-rate-and-bases/(key)
Example URI
PUT /research-common/api/v1/budget-personnel-rate-and-bases/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Personnel Rate And BasesPUT/research-common/api/v1/budget-personnel-rate-and-bases/
Example URI
PUT /research-common/api/v1/budget-personnel-rate-and-bases/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Personnel Rate And BasesPATCH/research-common/api/v1/budget-personnel-rate-and-bases/(key)
Example URI
PATCH /research-common/api/v1/budget-personnel-rate-and-bases/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Insert Budget Personnel Rate And BasesPOST/research-common/api/v1/budget-personnel-rate-and-bases/
Example URI
POST /research-common/api/v1/budget-personnel-rate-and-bases/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Personnel Rate And BasesPOST/research-common/api/v1/budget-personnel-rate-and-bases/
Example URI
POST /research-common/api/v1/budget-personnel-rate-and-bases/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"budgetPersonnelRateAndBaseId": "(val)",
"budgetPersonnelCalculatedAmountId": "(val)",
"budgetPersonnelLineItemId": "(val)",
"personId": "(val)",
"personNumber": "(val)",
"salaryRequested": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Personnel Rate And Bases by KeyDELETE/research-common/api/v1/budget-personnel-rate-and-bases/(key)
Example URI
DELETE /research-common/api/v1/budget-personnel-rate-and-bases/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Personnel Rate And BasesDELETE/research-common/api/v1/budget-personnel-rate-and-bases/
Example URI
DELETE /research-common/api/v1/budget-personnel-rate-and-bases/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Personnel Rate And Bases with MatchingDELETE/research-common/api/v1/budget-personnel-rate-and-bases/
Example URI
DELETE /research-common/api/v1/budget-personnel-rate-and-bases/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- budgetPersonnelRateAndBaseId
string(optional)Budget Personnel Rate And Base Id.
- budgetPersonnelCalculatedAmountId
string(optional)Budget Personnel Calculated Amount Id.
- budgetPersonnelLineItemId
string(optional)Budget Personnel Line Item Id.
- personId
string(optional)KcPerson Id. Maximum length is 40.
- personNumber
string(optional)Person Number.
- salaryRequested
string(optional)Salary Requested. Maximum length is 15.
- baseCostSharing
string(optional)Base Cost Sharing. Maximum length is 15.
- budgetPeriodId
string(optional)Budget Period Id.
- endDate
string(optional)End Date. Maximum length is 21.
- rateTypeCode
string(optional)Rate Type. Maximum length is 3.
- budgetId
string(optional)Budget Id.
- rateNumber
string(optional)Rate Number. Maximum length is 3.
- appliedRate
string(optional)Applied Rate. Maximum length is 7.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- calculatedCost
string(optional)Calculated Cost. Maximum length is 15.
- onOffCampusFlag
string(optional)On CampusContract?. Maximum length is 1.
- rateClassCode
string(optional)Rate Class. Maximum length is 3.
- calculatedCostSharing
string(optional)Calculated Cost Sharing. Maximum length is 15.
- lineItemNumber
string(optional)Line Item Number. Maximum length is 6.
- startDate
string(optional)Start Date. Maximum length is 21.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Persons ¶
Get Budget Persons by KeyGET/research-common/api/v1/budget-persons/(key)
Example URI
GET /research-common/api/v1/budget-persons/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Get All Budget PersonsGET/research-common/api/v1/budget-persons/
Example URI
GET /research-common/api/v1/budget-persons/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Persons with FilteringGET/research-common/api/v1/budget-persons/
Example URI
GET /research-common/api/v1/budget-persons/
URI Parameters
- personSequenceNumber
string(optional)Person Sequence Number.
- budgetId
string(optional)Budget Id.
- effectiveDate
string(optional)Salary Effective Date. Maximum length is 21.
- jobCode
string(optional)Job Code. Maximum length is 6.
- nonEmployeeFlag
string(optional)Non Employee Flag. Maximum length is 1.
- personId
string(optional)KcPerson Id. Maximum length is 40.
- rolodexId
string(optional)Rolodex Id.
- tbnId
string(optional)Tbn Id.
- appointmentTypeCode
string(optional)Appointment Type. Maximum length is 2.
- calculationBase
string(optional)Calculation Base. Maximum length is 15.
- personName
string(optional)Personnel. Maximum length is 90.
- salaryAnniversaryDate
string(optional)Salary Anniversary Date. Maximum length is 21.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget PersonsGET/research-common/api/v1/budget-persons/
Example URI
GET /research-common/api/v1/budget-persons/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"personSequenceNumber",
"budgetId",
"effectiveDate",
"jobCode",
"nonEmployeeFlag",
"personId",
"rolodexId",
"tbnId",
"appointmentTypeCode",
"calculationBase",
"personName",
"salaryAnniversaryDate",
"hierarchyProposalNumber",
"hiddenInHierarchy"
],
"primaryKey": "budget:personSequenceNumber"
}Get Blueprint API specification for Budget PersonsGET/research-common/api/v1/budget-persons/
Example URI
GET /research-common/api/v1/budget-persons/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Persons.md"
transfer-encoding: chunkedUpdate Budget PersonsPUT/research-common/api/v1/budget-persons/(key)
Example URI
PUT /research-common/api/v1/budget-persons/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget PersonsPUT/research-common/api/v1/budget-persons/
Example URI
PUT /research-common/api/v1/budget-persons/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget PersonsPATCH/research-common/api/v1/budget-persons/(key)
Example URI
PATCH /research-common/api/v1/budget-persons/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert Budget PersonsPOST/research-common/api/v1/budget-persons/
Example URI
POST /research-common/api/v1/budget-persons/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget PersonsPOST/research-common/api/v1/budget-persons/
Example URI
POST /research-common/api/v1/budget-persons/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"personSequenceNumber": "(val)",
"budgetId": "(val)",
"effectiveDate": "(val)",
"jobCode": "(val)",
"nonEmployeeFlag": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"tbnId": "(val)",
"appointmentTypeCode": "(val)",
"calculationBase": "(val)",
"personName": "(val)",
"salaryAnniversaryDate": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Persons by KeyDELETE/research-common/api/v1/budget-persons/(key)
Example URI
DELETE /research-common/api/v1/budget-persons/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget PersonsDELETE/research-common/api/v1/budget-persons/
Example URI
DELETE /research-common/api/v1/budget-persons/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Persons with MatchingDELETE/research-common/api/v1/budget-persons/
Example URI
DELETE /research-common/api/v1/budget-persons/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- personSequenceNumber
string(optional)Person Sequence Number.
- budgetId
string(optional)Budget Id.
- effectiveDate
string(optional)Salary Effective Date. Maximum length is 21.
- jobCode
string(optional)Job Code. Maximum length is 6.
- nonEmployeeFlag
string(optional)Non Employee Flag. Maximum length is 1.
- personId
string(optional)KcPerson Id. Maximum length is 40.
- rolodexId
string(optional)Rolodex Id.
- tbnId
string(optional)Tbn Id.
- appointmentTypeCode
string(optional)Appointment Type. Maximum length is 2.
- calculationBase
string(optional)Calculation Base. Maximum length is 15.
- personName
string(optional)Personnel. Maximum length is 90.
- salaryAnniversaryDate
string(optional)Salary Anniversary Date. Maximum length is 21.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Project Incomes ¶
Get Budget Project Incomes by KeyGET/research-common/api/v1/budget-project-incomes/(key)
Example URI
GET /research-common/api/v1/budget-project-incomes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Get All Budget Project IncomesGET/research-common/api/v1/budget-project-incomes/
Example URI
GET /research-common/api/v1/budget-project-incomes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Project Incomes with FilteringGET/research-common/api/v1/budget-project-incomes/
Example URI
GET /research-common/api/v1/budget-project-incomes/
URI Parameters
- documentComponentId
string(optional)Document Component Id. Maximum length is 5.
- budgetId
string(optional)Budget Id.
- budgetPeriodId
string(optional)Budget Period Id.
- budgetPeriodNumber
string(optional)Budget Period. Maximum length is 3.
- description
string(optional)Description. Maximum length is 2000.
- projectIncome
string(optional)Project Income. Maximum length is 15.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Project IncomesGET/research-common/api/v1/budget-project-incomes/
Example URI
GET /research-common/api/v1/budget-project-incomes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"documentComponentId",
"budgetId",
"budgetPeriodId",
"budgetPeriodNumber",
"description",
"projectIncome",
"hierarchyProposalNumber",
"hiddenInHierarchy"
],
"primaryKey": "budgetId:budgetPeriod:documentComponentId"
}Get Blueprint API specification for Budget Project IncomesGET/research-common/api/v1/budget-project-incomes/
Example URI
GET /research-common/api/v1/budget-project-incomes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Project Incomes.md"
transfer-encoding: chunkedUpdate Budget Project IncomesPUT/research-common/api/v1/budget-project-incomes/(key)
Example URI
PUT /research-common/api/v1/budget-project-incomes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Project IncomesPUT/research-common/api/v1/budget-project-incomes/
Example URI
PUT /research-common/api/v1/budget-project-incomes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Project IncomesPATCH/research-common/api/v1/budget-project-incomes/(key)
Example URI
PATCH /research-common/api/v1/budget-project-incomes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert Budget Project IncomesPOST/research-common/api/v1/budget-project-incomes/
Example URI
POST /research-common/api/v1/budget-project-incomes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Project IncomesPOST/research-common/api/v1/budget-project-incomes/
Example URI
POST /research-common/api/v1/budget-project-incomes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"budgetPeriodId": "(val)",
"budgetPeriodNumber": "(val)",
"description": "(val)",
"projectIncome": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Project Incomes by KeyDELETE/research-common/api/v1/budget-project-incomes/(key)
Example URI
DELETE /research-common/api/v1/budget-project-incomes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Project IncomesDELETE/research-common/api/v1/budget-project-incomes/
Example URI
DELETE /research-common/api/v1/budget-project-incomes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Project Incomes with MatchingDELETE/research-common/api/v1/budget-project-incomes/
Example URI
DELETE /research-common/api/v1/budget-project-incomes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- documentComponentId
string(optional)Document Component Id. Maximum length is 5.
- budgetId
string(optional)Budget Id.
- budgetPeriodId
string(optional)Budget Period Id.
- budgetPeriodNumber
string(optional)Budget Period. Maximum length is 3.
- description
string(optional)Description. Maximum length is 2000.
- projectIncome
string(optional)Project Income. Maximum length is 15.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Rate And Bases ¶
Get Budget Rate And Bases by KeyGET/research-common/api/v1/budget-rate-and-bases/(key)
Example URI
GET /research-common/api/v1/budget-rate-and-bases/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Get All Budget Rate And BasesGET/research-common/api/v1/budget-rate-and-bases/
Example URI
GET /research-common/api/v1/budget-rate-and-bases/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Rate And Bases with FilteringGET/research-common/api/v1/budget-rate-and-bases/
Example URI
GET /research-common/api/v1/budget-rate-and-bases/
URI Parameters
- baseCost
string(optional)Base Cost. Maximum length is 15.
- budgetRateAndBaseId
string(optional)Budget Rate And Base Id.
- budgetLineItemCalculatedAmountId
string(optional)Budget Line Item Calculated Amount Id.
- budgetLineItemId
string(optional)Budget Line Item Id.
- baseCostSharing
string(optional)Base Cost Sharing. Maximum length is 15.
- budgetPeriodId
string(optional)Budget Period Id.
- endDate
string(optional)End Date. Maximum length is 21.
- rateTypeCode
string(optional)Rate Type. Maximum length is 3.
- budgetId
string(optional)Budget Id.
- rateNumber
string(optional)Rate Number. Maximum length is 3.
- appliedRate
string(optional)Applied Rate. Maximum length is 7.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- calculatedCost
string(optional)Calculated Cost. Maximum length is 15.
- onOffCampusFlag
string(optional)On CampusContract?. Maximum length is 1.
- rateClassCode
string(optional)Rate Class. Maximum length is 3.
- calculatedCostSharing
string(optional)Calculated Cost Sharing. Maximum length is 15.
- lineItemNumber
string(optional)Line Item Number. Maximum length is 6.
- startDate
string(optional)Start Date. Maximum length is 21.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Rate And BasesGET/research-common/api/v1/budget-rate-and-bases/
Example URI
GET /research-common/api/v1/budget-rate-and-bases/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"baseCost",
"budgetRateAndBaseId",
"budgetLineItemCalculatedAmountId",
"budgetLineItemId",
"baseCostSharing",
"budgetPeriodId",
"endDate",
"rateTypeCode",
"budgetId",
"rateNumber",
"appliedRate",
"budgetPeriod",
"calculatedCost",
"onOffCampusFlag",
"rateClassCode",
"calculatedCostSharing",
"lineItemNumber",
"startDate"
],
"primaryKey": "budgetRateAndBaseId"
}Get Blueprint API specification for Budget Rate And BasesGET/research-common/api/v1/budget-rate-and-bases/
Example URI
GET /research-common/api/v1/budget-rate-and-bases/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Rate And Bases.md"
transfer-encoding: chunkedUpdate Budget Rate And BasesPUT/research-common/api/v1/budget-rate-and-bases/(key)
Example URI
PUT /research-common/api/v1/budget-rate-and-bases/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Rate And BasesPUT/research-common/api/v1/budget-rate-and-bases/
Example URI
PUT /research-common/api/v1/budget-rate-and-bases/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Rate And BasesPATCH/research-common/api/v1/budget-rate-and-bases/(key)
Example URI
PATCH /research-common/api/v1/budget-rate-and-bases/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Insert Budget Rate And BasesPOST/research-common/api/v1/budget-rate-and-bases/
Example URI
POST /research-common/api/v1/budget-rate-and-bases/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Rate And BasesPOST/research-common/api/v1/budget-rate-and-bases/
Example URI
POST /research-common/api/v1/budget-rate-and-bases/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"baseCost": "(val)",
"budgetRateAndBaseId": "(val)",
"budgetLineItemCalculatedAmountId": "(val)",
"budgetLineItemId": "(val)",
"baseCostSharing": "(val)",
"budgetPeriodId": "(val)",
"endDate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"rateNumber": "(val)",
"appliedRate": "(val)",
"budgetPeriod": "(val)",
"calculatedCost": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"calculatedCostSharing": "(val)",
"lineItemNumber": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Rate And Bases by KeyDELETE/research-common/api/v1/budget-rate-and-bases/(key)
Example URI
DELETE /research-common/api/v1/budget-rate-and-bases/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Rate And BasesDELETE/research-common/api/v1/budget-rate-and-bases/
Example URI
DELETE /research-common/api/v1/budget-rate-and-bases/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Rate And Bases with MatchingDELETE/research-common/api/v1/budget-rate-and-bases/
Example URI
DELETE /research-common/api/v1/budget-rate-and-bases/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- baseCost
string(optional)Base Cost. Maximum length is 15.
- budgetRateAndBaseId
string(optional)Budget Rate And Base Id.
- budgetLineItemCalculatedAmountId
string(optional)Budget Line Item Calculated Amount Id.
- budgetLineItemId
string(optional)Budget Line Item Id.
- baseCostSharing
string(optional)Base Cost Sharing. Maximum length is 15.
- budgetPeriodId
string(optional)Budget Period Id.
- endDate
string(optional)End Date. Maximum length is 21.
- rateTypeCode
string(optional)Rate Type. Maximum length is 3.
- budgetId
string(optional)Budget Id.
- rateNumber
string(optional)Rate Number. Maximum length is 3.
- appliedRate
string(optional)Applied Rate. Maximum length is 7.
- budgetPeriod
string(optional)Budget Period. Maximum length is 3.
- calculatedCost
string(optional)Calculated Cost. Maximum length is 15.
- onOffCampusFlag
string(optional)On CampusContract?. Maximum length is 1.
- rateClassCode
string(optional)Rate Class. Maximum length is 3.
- calculatedCostSharing
string(optional)Calculated Cost Sharing. Maximum length is 15.
- lineItemNumber
string(optional)Line Item Number. Maximum length is 6.
- startDate
string(optional)Start Date. Maximum length is 21.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Rates ¶
Get Budget Rates by KeyGET/research-common/api/v1/budget-rates/(key)
Example URI
GET /research-common/api/v1/budget-rates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Get All Budget RatesGET/research-common/api/v1/budget-rates/
Example URI
GET /research-common/api/v1/budget-rates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Rates with FilteringGET/research-common/api/v1/budget-rates/
Example URI
GET /research-common/api/v1/budget-rates/
URI Parameters
- activityTypeCode
string(optional)Activity Type Code. Maximum length is 3.
- applicableRate
string(optional)Applicable Rate. Maximum length is 7.
- instituteRate
string(optional)Institute Rate. Maximum length is 7.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
- budgetId
string(optional)Budget Id.
- onOffCampusFlag
string(optional)On Off Campus Flag. Maximum length is 1.
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- fiscalYear
string(optional)Fiscal Year. Maximum length is 4.
- startDate
string(optional)Start Date. Maximum length is 21.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget RatesGET/research-common/api/v1/budget-rates/
Example URI
GET /research-common/api/v1/budget-rates/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"activityTypeCode",
"applicableRate",
"instituteRate",
"rateTypeCode",
"budgetId",
"onOffCampusFlag",
"rateClassCode",
"fiscalYear",
"startDate"
],
"primaryKey": "budget:budgetId"
}Get Blueprint API specification for Budget RatesGET/research-common/api/v1/budget-rates/
Example URI
GET /research-common/api/v1/budget-rates/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Rates.md"
transfer-encoding: chunkedUpdate Budget RatesPUT/research-common/api/v1/budget-rates/(key)
Example URI
PUT /research-common/api/v1/budget-rates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget RatesPUT/research-common/api/v1/budget-rates/
Example URI
PUT /research-common/api/v1/budget-rates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget RatesPATCH/research-common/api/v1/budget-rates/(key)
Example URI
PATCH /research-common/api/v1/budget-rates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Insert Budget RatesPOST/research-common/api/v1/budget-rates/
Example URI
POST /research-common/api/v1/budget-rates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget RatesPOST/research-common/api/v1/budget-rates/
Example URI
POST /research-common/api/v1/budget-rates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
},
{
"activityTypeCode": "(val)",
"applicableRate": "(val)",
"instituteRate": "(val)",
"rateTypeCode": "(val)",
"budgetId": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"fiscalYear": "(val)",
"startDate": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Rates by KeyDELETE/research-common/api/v1/budget-rates/(key)
Example URI
DELETE /research-common/api/v1/budget-rates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget RatesDELETE/research-common/api/v1/budget-rates/
Example URI
DELETE /research-common/api/v1/budget-rates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Rates with MatchingDELETE/research-common/api/v1/budget-rates/
Example URI
DELETE /research-common/api/v1/budget-rates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- activityTypeCode
string(optional)Activity Type Code. Maximum length is 3.
- applicableRate
string(optional)Applicable Rate. Maximum length is 7.
- instituteRate
string(optional)Institute Rate. Maximum length is 7.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
- budgetId
string(optional)Budget Id.
- onOffCampusFlag
string(optional)On Off Campus Flag. Maximum length is 1.
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- fiscalYear
string(optional)Fiscal Year. Maximum length is 4.
- startDate
string(optional)Start Date. Maximum length is 21.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budget Unrecovered F And As ¶
Get Budget Unrecovered F And As by KeyGET/research-common/api/v1/budget-unrecovered-f-and-as/(key)
Example URI
GET /research-common/api/v1/budget-unrecovered-f-and-as/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Get All Budget Unrecovered F And AsGET/research-common/api/v1/budget-unrecovered-f-and-as/
Example URI
GET /research-common/api/v1/budget-unrecovered-f-and-as/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get All Budget Unrecovered F And As with FilteringGET/research-common/api/v1/budget-unrecovered-f-and-as/
Example URI
GET /research-common/api/v1/budget-unrecovered-f-and-as/
URI Parameters
- documentComponentId
string(optional)Document Component Id. Maximum length is 5.
- budgetId
string(optional)Budget Id.
- amount
string(optional)Amount. Maximum length is 15.
- applicableRate
string(optional)Applicable Rate. Maximum length is 6.
- onCampusFlag
string(optional)On CampusContractContract Flag. Maximum length is 1.
- fiscalYear
string(optional)Fiscal Year. Maximum length is 4.
- sourceAccount
string(optional)Source Account. Maximum length is 32.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Budget Unrecovered F And AsGET/research-common/api/v1/budget-unrecovered-f-and-as/
Example URI
GET /research-common/api/v1/budget-unrecovered-f-and-as/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"documentComponentId",
"budgetId",
"amount",
"applicableRate",
"onCampusFlag",
"fiscalYear",
"sourceAccount",
"hierarchyProposalNumber",
"hiddenInHierarchy"
],
"primaryKey": "budget:budgetId:documentComponentId"
}Get Blueprint API specification for Budget Unrecovered F And AsGET/research-common/api/v1/budget-unrecovered-f-and-as/
Example URI
GET /research-common/api/v1/budget-unrecovered-f-and-as/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budget Unrecovered F And As.md"
transfer-encoding: chunkedUpdate Budget Unrecovered F And AsPUT/research-common/api/v1/budget-unrecovered-f-and-as/(key)
Example URI
PUT /research-common/api/v1/budget-unrecovered-f-and-as/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Budget Unrecovered F And AsPUT/research-common/api/v1/budget-unrecovered-f-and-as/
Example URI
PUT /research-common/api/v1/budget-unrecovered-f-and-as/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Budget Unrecovered F And AsPATCH/research-common/api/v1/budget-unrecovered-f-and-as/(key)
Example URI
PATCH /research-common/api/v1/budget-unrecovered-f-and-as/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert Budget Unrecovered F And AsPOST/research-common/api/v1/budget-unrecovered-f-and-as/
Example URI
POST /research-common/api/v1/budget-unrecovered-f-and-as/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Budget Unrecovered F And AsPOST/research-common/api/v1/budget-unrecovered-f-and-as/
Example URI
POST /research-common/api/v1/budget-unrecovered-f-and-as/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
},
{
"documentComponentId": "(val)",
"budgetId": "(val)",
"amount": "(val)",
"applicableRate": "(val)",
"onCampusFlag": "(val)",
"fiscalYear": "(val)",
"sourceAccount": "(val)",
"hierarchyProposalNumber": "(val)",
"hiddenInHierarchy": "(val)",
"_primaryKey": "(val)"
}
]Delete Budget Unrecovered F And As by KeyDELETE/research-common/api/v1/budget-unrecovered-f-and-as/(key)
Example URI
DELETE /research-common/api/v1/budget-unrecovered-f-and-as/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Unrecovered F And AsDELETE/research-common/api/v1/budget-unrecovered-f-and-as/
Example URI
DELETE /research-common/api/v1/budget-unrecovered-f-and-as/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budget Unrecovered F And As with MatchingDELETE/research-common/api/v1/budget-unrecovered-f-and-as/
Example URI
DELETE /research-common/api/v1/budget-unrecovered-f-and-as/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- documentComponentId
string(optional)Document Component Id. Maximum length is 5.
- budgetId
string(optional)Budget Id.
- amount
string(optional)Amount. Maximum length is 15.
- applicableRate
string(optional)Applicable Rate. Maximum length is 6.
- onCampusFlag
string(optional)On CampusContractContract Flag. Maximum length is 1.
- fiscalYear
string(optional)Fiscal Year. Maximum length is 4.
- sourceAccount
string(optional)Source Account. Maximum length is 32.
- hierarchyProposalNumber
string(optional)Hierarchy Proposal Number.
- hiddenInHierarchy
string(optional)Hidden In Hierarchy.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Budgets ¶
Get Budgets by KeyGET/research-common/api/v1/budgets/(key)
Example URI
GET /research-common/api/v1/budgets/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}Get All BudgetsGET/research-common/api/v1/budgets/
Example URI
GET /research-common/api/v1/budgets/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
},
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}
]Get All Budgets with FilteringGET/research-common/api/v1/budgets/
Example URI
GET /research-common/api/v1/budgets/
URI Parameters
- parentDocumentTypeCode
string(optional)Parent Document Type Code. Maximum length is 31.
- budgetJustification
string(optional)Budget Justification. Maximum length is 4000.
- createTimestamp
string(optional)Create Timestamp.
- createUser
string(optional)Create User.
- budgetAdjustmentDocumentNumber
string(optional)Budget Adjustment Document Number.
- residualFunds
string(optional)Residual Funds. Maximum length is 15.
- endDate
string(optional)Project End Date. Maximum length is 21.
- modularBudgetFlag
string(optional)Modular Budget Flag. Maximum length is 1.
- documentNumber
string(optional)Document Number.
- totalDirectCostLimit
string(optional)Total Direct Cost Limit. Maximum length is 15.
- costSharingAmount
string(optional)Cost Sharing Amount. Maximum length is 15.
- totalDirectCost
string(optional)Total Direct Cost. Maximum length is 15.
- ohRateClassCode
string(optional)F&A Rate Type. Maximum length is 3.
- comments
string(optional)The Comments for this budget. Maximum length is 2000.
- underrecoveryAmount
string(optional)Underrecovery Amount. Maximum length is 15.
- budgetId
string(optional)Budget Id.
- budgetVersionNumber
string(optional)Budget Version Number for header display. Maximum length is 3.
- urRateClassCode
string(optional)Ur Rate Class Code. Maximum length is 3.
- totalIndirectCost
string(optional)Total Indirect Cost. Maximum length is 15.
- totalCostLimit
string(optional)Total Cost Limit. Maximum length is 15.
- name
string(optional)A free-form text field that describes the purpose or function of the document. Maximum length is 40.
- onOffCampusFlag
string(optional)On Off CampusContractContract flag allowing the user to set all expense line items to be either ‘all on’ or ‘all off-campus’; overriding the object code level defaults. Maximum length is 3.
- submitCostSharingFlag
string(optional)Submit Cost Sharing Flag. Maximum length is 1.
- ohRateTypeCode
string(optional)F&A Rate Type. Maximum length is 3.
- startDate
string(optional)Project Start Date. Maximum length is 21.
- totalCost
string(optional)Total Cost. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
},
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for BudgetsGET/research-common/api/v1/budgets/
Example URI
GET /research-common/api/v1/budgets/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"parentDocumentTypeCode",
"budgetJustification",
"createTimestamp",
"createUser",
"budgetAdjustmentDocumentNumber",
"residualFunds",
"endDate",
"modularBudgetFlag",
"documentNumber",
"totalDirectCostLimit",
"costSharingAmount",
"totalDirectCost",
"ohRateClassCode",
"comments",
"underrecoveryAmount",
"budgetId",
"budgetVersionNumber",
"urRateClassCode",
"totalIndirectCost",
"totalCostLimit",
"name",
"onOffCampusFlag",
"submitCostSharingFlag",
"ohRateTypeCode",
"startDate",
"totalCost"
],
"primaryKey": "budgetId"
}Get Blueprint API specification for BudgetsGET/research-common/api/v1/budgets/
Example URI
GET /research-common/api/v1/budgets/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Budgets.md"
transfer-encoding: chunkedUpdate BudgetsPUT/research-common/api/v1/budgets/(key)
Example URI
PUT /research-common/api/v1/budgets/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple BudgetsPUT/research-common/api/v1/budgets/
Example URI
PUT /research-common/api/v1/budgets/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
},
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes BudgetsPATCH/research-common/api/v1/budgets/(key)
Example URI
PATCH /research-common/api/v1/budgets/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}Insert BudgetsPOST/research-common/api/v1/budgets/
Example URI
POST /research-common/api/v1/budgets/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}Insert Multiple BudgetsPOST/research-common/api/v1/budgets/
Example URI
POST /research-common/api/v1/budgets/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
},
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
},
{
"parentDocumentTypeCode": "(val)",
"budgetJustification": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"budgetAdjustmentDocumentNumber": "(val)",
"residualFunds": "(val)",
"endDate": "(val)",
"modularBudgetFlag": "(val)",
"documentNumber": "(val)",
"totalDirectCostLimit": "(val)",
"costSharingAmount": "(val)",
"totalDirectCost": "(val)",
"ohRateClassCode": "(val)",
"comments": "(val)",
"underrecoveryAmount": "(val)",
"budgetId": "(val)",
"budgetVersionNumber": "(val)",
"urRateClassCode": "(val)",
"totalIndirectCost": "(val)",
"totalCostLimit": "(val)",
"name": "(val)",
"onOffCampusFlag": "(val)",
"submitCostSharingFlag": "(val)",
"ohRateTypeCode": "(val)",
"startDate": "(val)",
"totalCost": "(val)",
"_primaryKey": "(val)"
}
]Delete Budgets by KeyDELETE/research-common/api/v1/budgets/(key)
Example URI
DELETE /research-common/api/v1/budgets/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All BudgetsDELETE/research-common/api/v1/budgets/
Example URI
DELETE /research-common/api/v1/budgets/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Budgets with MatchingDELETE/research-common/api/v1/budgets/
Example URI
DELETE /research-common/api/v1/budgets/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- parentDocumentTypeCode
string(optional)Parent Document Type Code. Maximum length is 31.
- budgetJustification
string(optional)Budget Justification. Maximum length is 4000.
- createTimestamp
string(optional)Create Timestamp.
- createUser
string(optional)Create User.
- budgetAdjustmentDocumentNumber
string(optional)Budget Adjustment Document Number.
- residualFunds
string(optional)Residual Funds. Maximum length is 15.
- endDate
string(optional)Project End Date. Maximum length is 21.
- modularBudgetFlag
string(optional)Modular Budget Flag. Maximum length is 1.
- documentNumber
string(optional)Document Number.
- totalDirectCostLimit
string(optional)Total Direct Cost Limit. Maximum length is 15.
- costSharingAmount
string(optional)Cost Sharing Amount. Maximum length is 15.
- totalDirectCost
string(optional)Total Direct Cost. Maximum length is 15.
- ohRateClassCode
string(optional)F&A Rate Type. Maximum length is 3.
- comments
string(optional)The Comments for this budget. Maximum length is 2000.
- underrecoveryAmount
string(optional)Underrecovery Amount. Maximum length is 15.
- budgetId
string(optional)Budget Id.
- budgetVersionNumber
string(optional)Budget Version Number for header display. Maximum length is 3.
- urRateClassCode
string(optional)Ur Rate Class Code. Maximum length is 3.
- totalIndirectCost
string(optional)Total Indirect Cost. Maximum length is 15.
- totalCostLimit
string(optional)Total Cost Limit. Maximum length is 15.
- name
string(optional)A free-form text field that describes the purpose or function of the document. Maximum length is 40.
- onOffCampusFlag
string(optional)On Off CampusContractContract flag allowing the user to set all expense line items to be either ‘all on’ or ‘all off-campus’; overriding the object code level defaults. Maximum length is 3.
- submitCostSharingFlag
string(optional)Submit Cost Sharing Flag. Maximum length is 1.
- ohRateTypeCode
string(optional)F&A Rate Type. Maximum length is 3.
- startDate
string(optional)Project Start Date. Maximum length is 21.
- totalCost
string(optional)Total Cost. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Cfdas ¶
Get Cfdas by KeyGET/research-common/api/v1/cfdas/(key)
Example URI
GET /research-common/api/v1/cfdas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
}Get All CfdasGET/research-common/api/v1/cfdas/
Example URI
GET /research-common/api/v1/cfdas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
},
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
}
]Get All Cfdas with FilteringGET/research-common/api/v1/cfdas/
Example URI
GET /research-common/api/v1/cfdas/
URI Parameters
- cfdaNumber
string(optional)A unique identifier for the sponsor and the funding opportunity announcement. AKA “Catalogue of Federal Domestic Assistance Number.” The format for this CFDA Number is XX.XXX. Maximum length is 7.
- cfdaProgramTitleName
string(optional)CFDA Program Title Name. Maximum length is 300.
- active
string(optional)Active. Maximum length is 1.
- cfdaMaintenanceTypeId
string(optional)CFDA Maintenance Type Id. Maximum length is 10.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
},
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for CfdasGET/research-common/api/v1/cfdas/
Example URI
GET /research-common/api/v1/cfdas/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"cfdaNumber",
"cfdaProgramTitleName",
"active",
"cfdaMaintenanceTypeId"
],
"primaryKey": "cfdaNumber"
}Get Blueprint API specification for CfdasGET/research-common/api/v1/cfdas/
Example URI
GET /research-common/api/v1/cfdas/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Cfdas.md"
transfer-encoding: chunkedUpdate CfdasPUT/research-common/api/v1/cfdas/(key)
Example URI
PUT /research-common/api/v1/cfdas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple CfdasPUT/research-common/api/v1/cfdas/
Example URI
PUT /research-common/api/v1/cfdas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
},
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes CfdasPATCH/research-common/api/v1/cfdas/(key)
Example URI
PATCH /research-common/api/v1/cfdas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
}Insert CfdasPOST/research-common/api/v1/cfdas/
Example URI
POST /research-common/api/v1/cfdas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple CfdasPOST/research-common/api/v1/cfdas/
Example URI
POST /research-common/api/v1/cfdas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
},
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
},
{
"cfdaNumber": "(val)",
"cfdaProgramTitleName": "(val)",
"active": "(val)",
"cfdaMaintenanceTypeId": "(val)",
"_primaryKey": "(val)"
}
]Delete Cfdas by KeyDELETE/research-common/api/v1/cfdas/(key)
Example URI
DELETE /research-common/api/v1/cfdas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All CfdasDELETE/research-common/api/v1/cfdas/
Example URI
DELETE /research-common/api/v1/cfdas/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Cfdas with MatchingDELETE/research-common/api/v1/cfdas/
Example URI
DELETE /research-common/api/v1/cfdas/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- cfdaNumber
string(optional)A unique identifier for the sponsor and the funding opportunity announcement. AKA “Catalogue of Federal Domestic Assistance Number.” The format for this CFDA Number is XX.XXX. Maximum length is 7.
- cfdaProgramTitleName
string(optional)CFDA Program Title Name. Maximum length is 300.
- active
string(optional)Active. Maximum length is 1.
- cfdaMaintenanceTypeId
string(optional)CFDA Maintenance Type Id. Maximum length is 10.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Citizenship Types ¶
Get Citizenship Types by KeyGET/research-common/api/v1/citizenship-types/(key)
Example URI
GET /research-common/api/v1/citizenship-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Citizenship TypesGET/research-common/api/v1/citizenship-types/
Example URI
GET /research-common/api/v1/citizenship-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Citizenship Types with FilteringGET/research-common/api/v1/citizenship-types/
Example URI
GET /research-common/api/v1/citizenship-types/
URI Parameters
- code
string(optional)Citizenship Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 40.
- active
string(optional)Active.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Citizenship TypesGET/research-common/api/v1/citizenship-types/
Example URI
GET /research-common/api/v1/citizenship-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description",
"active"
],
"primaryKey": "code"
}Get Blueprint API specification for Citizenship TypesGET/research-common/api/v1/citizenship-types/
Example URI
GET /research-common/api/v1/citizenship-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Citizenship Types.md"
transfer-encoding: chunkedUpdate Citizenship TypesPUT/research-common/api/v1/citizenship-types/(key)
Example URI
PUT /research-common/api/v1/citizenship-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Citizenship TypesPUT/research-common/api/v1/citizenship-types/
Example URI
PUT /research-common/api/v1/citizenship-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Citizenship TypesPATCH/research-common/api/v1/citizenship-types/(key)
Example URI
PATCH /research-common/api/v1/citizenship-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Citizenship TypesPOST/research-common/api/v1/citizenship-types/
Example URI
POST /research-common/api/v1/citizenship-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Citizenship TypesPOST/research-common/api/v1/citizenship-types/
Example URI
POST /research-common/api/v1/citizenship-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Citizenship Types by KeyDELETE/research-common/api/v1/citizenship-types/(key)
Example URI
DELETE /research-common/api/v1/citizenship-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Citizenship TypesDELETE/research-common/api/v1/citizenship-types/
Example URI
DELETE /research-common/api/v1/citizenship-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Citizenship Types with MatchingDELETE/research-common/api/v1/citizenship-types/
Example URI
DELETE /research-common/api/v1/citizenship-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Citizenship Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 40.
- active
string(optional)Active.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Coeus Modules ¶
Get Coeus Modules by KeyGET/research-common/api/v1/coeus-modules/(key)
Example URI
GET /research-common/api/v1/coeus-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Coeus ModulesGET/research-common/api/v1/coeus-modules/
Example URI
GET /research-common/api/v1/coeus-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Coeus Modules with FilteringGET/research-common/api/v1/coeus-modules/
Example URI
GET /research-common/api/v1/coeus-modules/
URI Parameters
- moduleCode
string(optional)Module Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Coeus ModulesGET/research-common/api/v1/coeus-modules/
Example URI
GET /research-common/api/v1/coeus-modules/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"moduleCode",
"description"
],
"primaryKey": "moduleCode"
}Get Blueprint API specification for Coeus ModulesGET/research-common/api/v1/coeus-modules/
Example URI
GET /research-common/api/v1/coeus-modules/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Coeus Modules.md"
transfer-encoding: chunkedUpdate Coeus ModulesPUT/research-common/api/v1/coeus-modules/(key)
Example URI
PUT /research-common/api/v1/coeus-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Coeus ModulesPUT/research-common/api/v1/coeus-modules/
Example URI
PUT /research-common/api/v1/coeus-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Coeus ModulesPATCH/research-common/api/v1/coeus-modules/(key)
Example URI
PATCH /research-common/api/v1/coeus-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Coeus ModulesPOST/research-common/api/v1/coeus-modules/
Example URI
POST /research-common/api/v1/coeus-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Coeus ModulesPOST/research-common/api/v1/coeus-modules/
Example URI
POST /research-common/api/v1/coeus-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"moduleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Coeus Modules by KeyDELETE/research-common/api/v1/coeus-modules/(key)
Example URI
DELETE /research-common/api/v1/coeus-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Coeus ModulesDELETE/research-common/api/v1/coeus-modules/
Example URI
DELETE /research-common/api/v1/coeus-modules/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Coeus Modules with MatchingDELETE/research-common/api/v1/coeus-modules/
Example URI
DELETE /research-common/api/v1/coeus-modules/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- moduleCode
string(optional)Module Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Coeus Sub Modules ¶
Get Coeus Sub Modules by KeyGET/research-common/api/v1/coeus-sub-modules/(key)
Example URI
GET /research-common/api/v1/coeus-sub-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
}Get All Coeus Sub ModulesGET/research-common/api/v1/coeus-sub-modules/
Example URI
GET /research-common/api/v1/coeus-sub-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
},
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
}
]Get All Coeus Sub Modules with FilteringGET/research-common/api/v1/coeus-sub-modules/
Example URI
GET /research-common/api/v1/coeus-sub-modules/
URI Parameters
- coeusSubModuleId
string(optional)Coeus Sub Module Id. Maximum length is 12.
- moduleCode
string(optional)Module Code. Maximum length is 3.
- subModuleCode
string(optional)Sub Module Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- requireUniqueQuestionnareUsage
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
},
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Coeus Sub ModulesGET/research-common/api/v1/coeus-sub-modules/
Example URI
GET /research-common/api/v1/coeus-sub-modules/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"coeusSubModuleId",
"moduleCode",
"subModuleCode",
"description",
"requireUniqueQuestionnareUsage"
],
"primaryKey": "coeusSubModuleId"
}Get Blueprint API specification for Coeus Sub ModulesGET/research-common/api/v1/coeus-sub-modules/
Example URI
GET /research-common/api/v1/coeus-sub-modules/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Coeus Sub Modules.md"
transfer-encoding: chunkedUpdate Coeus Sub ModulesPUT/research-common/api/v1/coeus-sub-modules/(key)
Example URI
PUT /research-common/api/v1/coeus-sub-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Coeus Sub ModulesPUT/research-common/api/v1/coeus-sub-modules/
Example URI
PUT /research-common/api/v1/coeus-sub-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
},
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Coeus Sub ModulesPATCH/research-common/api/v1/coeus-sub-modules/(key)
Example URI
PATCH /research-common/api/v1/coeus-sub-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
}Insert Coeus Sub ModulesPOST/research-common/api/v1/coeus-sub-modules/
Example URI
POST /research-common/api/v1/coeus-sub-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Coeus Sub ModulesPOST/research-common/api/v1/coeus-sub-modules/
Example URI
POST /research-common/api/v1/coeus-sub-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
},
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
},
{
"coeusSubModuleId": "(val)",
"moduleCode": "(val)",
"subModuleCode": "(val)",
"description": "(val)",
"requireUniqueQuestionnareUsage": "(val)",
"_primaryKey": "(val)"
}
]Delete Coeus Sub Modules by KeyDELETE/research-common/api/v1/coeus-sub-modules/(key)
Example URI
DELETE /research-common/api/v1/coeus-sub-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Coeus Sub ModulesDELETE/research-common/api/v1/coeus-sub-modules/
Example URI
DELETE /research-common/api/v1/coeus-sub-modules/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Coeus Sub Modules with MatchingDELETE/research-common/api/v1/coeus-sub-modules/
Example URI
DELETE /research-common/api/v1/coeus-sub-modules/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- coeusSubModuleId
string(optional)Coeus Sub Module Id. Maximum length is 12.
- moduleCode
string(optional)Module Code. Maximum length is 3.
- subModuleCode
string(optional)Sub Module Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- requireUniqueQuestionnareUsage
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Comment Types ¶
Get Comment Types by KeyGET/research-common/api/v1/comment-types/(key)
Example URI
GET /research-common/api/v1/comment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
}Get All Comment TypesGET/research-common/api/v1/comment-types/
Example URI
GET /research-common/api/v1/comment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
}
]Get All Comment Types with FilteringGET/research-common/api/v1/comment-types/
Example URI
GET /research-common/api/v1/comment-types/
URI Parameters
- commentTypeCode
string(optional)Comment Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- templateFlag
string(optional)Template Flag. Maximum length is 1.
- checklistFlag
string(optional)Checklist Flag. Maximum length is 1.
- awardCommentScreenFlag
string(optional)Award Comment Screen Flag. Maximum length is 1.
- subAwardCommentScreenFlag
string(optional)SubAward Comment Screen Flag. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Comment TypesGET/research-common/api/v1/comment-types/
Example URI
GET /research-common/api/v1/comment-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"commentTypeCode",
"description",
"templateFlag",
"checklistFlag",
"awardCommentScreenFlag",
"subAwardCommentScreenFlag"
],
"primaryKey": "commentTypeCode"
}Get Blueprint API specification for Comment TypesGET/research-common/api/v1/comment-types/
Example URI
GET /research-common/api/v1/comment-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Comment Types.md"
transfer-encoding: chunkedUpdate Comment TypesPUT/research-common/api/v1/comment-types/(key)
Example URI
PUT /research-common/api/v1/comment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Comment TypesPUT/research-common/api/v1/comment-types/
Example URI
PUT /research-common/api/v1/comment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Comment TypesPATCH/research-common/api/v1/comment-types/(key)
Example URI
PATCH /research-common/api/v1/comment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
}Insert Comment TypesPOST/research-common/api/v1/comment-types/
Example URI
POST /research-common/api/v1/comment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Comment TypesPOST/research-common/api/v1/comment-types/
Example URI
POST /research-common/api/v1/comment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
},
{
"commentTypeCode": "(val)",
"description": "(val)",
"templateFlag": "(val)",
"checklistFlag": "(val)",
"awardCommentScreenFlag": "(val)",
"subAwardCommentScreenFlag": "(val)",
"_primaryKey": "(val)"
}
]Delete Comment Types by KeyDELETE/research-common/api/v1/comment-types/(key)
Example URI
DELETE /research-common/api/v1/comment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Comment TypesDELETE/research-common/api/v1/comment-types/
Example URI
DELETE /research-common/api/v1/comment-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Comment Types with MatchingDELETE/research-common/api/v1/comment-types/
Example URI
DELETE /research-common/api/v1/comment-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- commentTypeCode
string(optional)Comment Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- templateFlag
string(optional)Template Flag. Maximum length is 1.
- checklistFlag
string(optional)Checklist Flag. Maximum length is 1.
- awardCommentScreenFlag
string(optional)Award Comment Screen Flag. Maximum length is 1.
- subAwardCommentScreenFlag
string(optional)SubAward Comment Screen Flag. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Cost Elements ¶
Get Cost Elements by KeyGET/research-common/api/v1/cost-elements/(key)
Example URI
GET /research-common/api/v1/cost-elements/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Get All Cost ElementsGET/research-common/api/v1/cost-elements/
Example URI
GET /research-common/api/v1/cost-elements/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Cost Elements with FilteringGET/research-common/api/v1/cost-elements/
Example URI
GET /research-common/api/v1/cost-elements/
URI Parameters
- costElement
string(optional)Object Code Name. Maximum length is 8.
- budgetCategoryCode
string(optional)Budget Category Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- onOffCampusFlag
string(optional)On CampusContract. Maximum length is 1.
- active
string(optional)Active. Maximum length is 1.
- financialObjectCode
string(optional)Financial Object Code. Maximum length is 8.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Cost ElementsGET/research-common/api/v1/cost-elements/
Example URI
GET /research-common/api/v1/cost-elements/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"costElement",
"budgetCategoryCode",
"description",
"onOffCampusFlag",
"active",
"financialObjectCode",
"unitNumber"
],
"primaryKey": "costElement"
}Get Blueprint API specification for Cost ElementsGET/research-common/api/v1/cost-elements/
Example URI
GET /research-common/api/v1/cost-elements/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Cost Elements.md"
transfer-encoding: chunkedUpdate Cost ElementsPUT/research-common/api/v1/cost-elements/(key)
Example URI
PUT /research-common/api/v1/cost-elements/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Cost ElementsPUT/research-common/api/v1/cost-elements/
Example URI
PUT /research-common/api/v1/cost-elements/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Cost ElementsPATCH/research-common/api/v1/cost-elements/(key)
Example URI
PATCH /research-common/api/v1/cost-elements/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Insert Cost ElementsPOST/research-common/api/v1/cost-elements/
Example URI
POST /research-common/api/v1/cost-elements/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Cost ElementsPOST/research-common/api/v1/cost-elements/
Example URI
POST /research-common/api/v1/cost-elements/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"budgetCategoryCode": "(val)",
"description": "(val)",
"onOffCampusFlag": "(val)",
"active": "(val)",
"financialObjectCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Cost Elements by KeyDELETE/research-common/api/v1/cost-elements/(key)
Example URI
DELETE /research-common/api/v1/cost-elements/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Cost ElementsDELETE/research-common/api/v1/cost-elements/
Example URI
DELETE /research-common/api/v1/cost-elements/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Cost Elements with MatchingDELETE/research-common/api/v1/cost-elements/
Example URI
DELETE /research-common/api/v1/cost-elements/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- costElement
string(optional)Object Code Name. Maximum length is 8.
- budgetCategoryCode
string(optional)Budget Category Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- onOffCampusFlag
string(optional)On CampusContract. Maximum length is 1.
- active
string(optional)Active. Maximum length is 1.
- financialObjectCode
string(optional)Financial Object Code. Maximum length is 8.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Custom Attribute Data Types ¶
Get Custom Attribute Data Types by KeyGET/research-common/api/v1/custom-attribute-data-types/(key)
Example URI
GET /research-common/api/v1/custom-attribute-data-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Custom Attribute Data TypesGET/research-common/api/v1/custom-attribute-data-types/
Example URI
GET /research-common/api/v1/custom-attribute-data-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Custom Attribute Data Types with FilteringGET/research-common/api/v1/custom-attribute-data-types/
Example URI
GET /research-common/api/v1/custom-attribute-data-types/
URI Parameters
- code
string(optional)Data Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Custom Attribute Data TypesGET/research-common/api/v1/custom-attribute-data-types/
Example URI
GET /research-common/api/v1/custom-attribute-data-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Custom Attribute Data TypesGET/research-common/api/v1/custom-attribute-data-types/
Example URI
GET /research-common/api/v1/custom-attribute-data-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Custom Attribute Data Types.md"
transfer-encoding: chunkedUpdate Custom Attribute Data TypesPUT/research-common/api/v1/custom-attribute-data-types/(key)
Example URI
PUT /research-common/api/v1/custom-attribute-data-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Custom Attribute Data TypesPUT/research-common/api/v1/custom-attribute-data-types/
Example URI
PUT /research-common/api/v1/custom-attribute-data-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Custom Attribute Data TypesPATCH/research-common/api/v1/custom-attribute-data-types/(key)
Example URI
PATCH /research-common/api/v1/custom-attribute-data-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Custom Attribute Data TypesPOST/research-common/api/v1/custom-attribute-data-types/
Example URI
POST /research-common/api/v1/custom-attribute-data-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Custom Attribute Data TypesPOST/research-common/api/v1/custom-attribute-data-types/
Example URI
POST /research-common/api/v1/custom-attribute-data-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Custom Attribute Data Types by KeyDELETE/research-common/api/v1/custom-attribute-data-types/(key)
Example URI
DELETE /research-common/api/v1/custom-attribute-data-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Custom Attribute Data TypesDELETE/research-common/api/v1/custom-attribute-data-types/
Example URI
DELETE /research-common/api/v1/custom-attribute-data-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Custom Attribute Data Types with MatchingDELETE/research-common/api/v1/custom-attribute-data-types/
Example URI
DELETE /research-common/api/v1/custom-attribute-data-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Data Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Custom Attribute Document Values ¶
Get Custom Attribute Document Values by KeyGET/research-common/api/v1/custom-attribute-document-values/(key)
Example URI
GET /research-common/api/v1/custom-attribute-document-values/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Get All Custom Attribute Document ValuesGET/research-common/api/v1/custom-attribute-document-values/
Example URI
GET /research-common/api/v1/custom-attribute-document-values/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Get All Custom Attribute Document Values with FilteringGET/research-common/api/v1/custom-attribute-document-values/
Example URI
GET /research-common/api/v1/custom-attribute-document-values/
URI Parameters
- id
string(optional)- documentNumber
string(optional)- value
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Custom Attribute Document ValuesGET/research-common/api/v1/custom-attribute-document-values/
Example URI
GET /research-common/api/v1/custom-attribute-document-values/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"documentNumber",
"value"
],
"primaryKey": "documentNumber:id"
}Get Blueprint API specification for Custom Attribute Document ValuesGET/research-common/api/v1/custom-attribute-document-values/
Example URI
GET /research-common/api/v1/custom-attribute-document-values/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Custom Attribute Document Values.md"
transfer-encoding: chunkedUpdate Custom Attribute Document ValuesPUT/research-common/api/v1/custom-attribute-document-values/(key)
Example URI
PUT /research-common/api/v1/custom-attribute-document-values/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Custom Attribute Document ValuesPUT/research-common/api/v1/custom-attribute-document-values/
Example URI
PUT /research-common/api/v1/custom-attribute-document-values/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Custom Attribute Document ValuesPATCH/research-common/api/v1/custom-attribute-document-values/(key)
Example URI
PATCH /research-common/api/v1/custom-attribute-document-values/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Insert Custom Attribute Document ValuesPOST/research-common/api/v1/custom-attribute-document-values/
Example URI
POST /research-common/api/v1/custom-attribute-document-values/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Custom Attribute Document ValuesPOST/research-common/api/v1/custom-attribute-document-values/
Example URI
POST /research-common/api/v1/custom-attribute-document-values/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Delete Custom Attribute Document Values by KeyDELETE/research-common/api/v1/custom-attribute-document-values/(key)
Example URI
DELETE /research-common/api/v1/custom-attribute-document-values/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Custom Attribute Document ValuesDELETE/research-common/api/v1/custom-attribute-document-values/
Example URI
DELETE /research-common/api/v1/custom-attribute-document-values/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Custom Attribute Document Values with MatchingDELETE/research-common/api/v1/custom-attribute-document-values/
Example URI
DELETE /research-common/api/v1/custom-attribute-document-values/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)- documentNumber
string(optional)- value
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Custom Attribute Documents ¶
Get Custom Attribute Documents by KeyGET/research-common/api/v1/custom-attribute-documents/(key)
Example URI
GET /research-common/api/v1/custom-attribute-documents/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Custom Attribute DocumentsGET/research-common/api/v1/custom-attribute-documents/
Example URI
GET /research-common/api/v1/custom-attribute-documents/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Custom Attribute Documents with FilteringGET/research-common/api/v1/custom-attribute-documents/
Example URI
GET /research-common/api/v1/custom-attribute-documents/
URI Parameters
- id
string(optional)Custom Attribute ID. Maximum length is 12.
- documentTypeName
string(optional)Document Type Code. Maximum length is 4.
- required
string(optional)Required. Maximum length is 1.
- typeName
string(optional)Type Name. Maximum length is 100.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Custom Attribute DocumentsGET/research-common/api/v1/custom-attribute-documents/
Example URI
GET /research-common/api/v1/custom-attribute-documents/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"documentTypeName",
"required",
"typeName",
"active"
],
"primaryKey": "documentTypeName:id"
}Get Blueprint API specification for Custom Attribute DocumentsGET/research-common/api/v1/custom-attribute-documents/
Example URI
GET /research-common/api/v1/custom-attribute-documents/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Custom Attribute Documents.md"
transfer-encoding: chunkedUpdate Custom Attribute DocumentsPUT/research-common/api/v1/custom-attribute-documents/(key)
Example URI
PUT /research-common/api/v1/custom-attribute-documents/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Custom Attribute DocumentsPUT/research-common/api/v1/custom-attribute-documents/
Example URI
PUT /research-common/api/v1/custom-attribute-documents/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Custom Attribute DocumentsPATCH/research-common/api/v1/custom-attribute-documents/(key)
Example URI
PATCH /research-common/api/v1/custom-attribute-documents/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Custom Attribute DocumentsPOST/research-common/api/v1/custom-attribute-documents/
Example URI
POST /research-common/api/v1/custom-attribute-documents/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Custom Attribute DocumentsPOST/research-common/api/v1/custom-attribute-documents/
Example URI
POST /research-common/api/v1/custom-attribute-documents/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentTypeName": "(val)",
"required": "(val)",
"typeName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Custom Attribute Documents by KeyDELETE/research-common/api/v1/custom-attribute-documents/(key)
Example URI
DELETE /research-common/api/v1/custom-attribute-documents/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Custom Attribute DocumentsDELETE/research-common/api/v1/custom-attribute-documents/
Example URI
DELETE /research-common/api/v1/custom-attribute-documents/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Custom Attribute Documents with MatchingDELETE/research-common/api/v1/custom-attribute-documents/
Example URI
DELETE /research-common/api/v1/custom-attribute-documents/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Custom Attribute ID. Maximum length is 12.
- documentTypeName
string(optional)Document Type Code. Maximum length is 4.
- required
string(optional)Required. Maximum length is 1.
- typeName
string(optional)Type Name. Maximum length is 100.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Custom Attributes ¶
Get Custom Attributes by KeyGET/research-common/api/v1/custom-attributes/(key)
Example URI
GET /research-common/api/v1/custom-attributes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Get All Custom AttributesGET/research-common/api/v1/custom-attributes/
Example URI
GET /research-common/api/v1/custom-attributes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Get All Custom Attributes with FilteringGET/research-common/api/v1/custom-attributes/
Example URI
GET /research-common/api/v1/custom-attributes/
URI Parameters
- id
string(optional)Id. Maximum length is 12.
- dataLength
string(optional)Data Length. Maximum length is 4.
- dataTypeCode
string(optional)Data Type Code. Maximum length is 3.
- defaultValue
string(optional)Default Value. Maximum length is 2000.
- groupName
string(optional)Group Name. Maximum length is 250.
- label
string(optional)Label. Maximum length is 30.
- lookupClass
string(optional)Lookup Class. Maximum length is 100.
- lookupReturn
string(optional)Lookup Return. Maximum length is 30.
- name
string(optional)Name. Maximum length is 30.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Custom AttributesGET/research-common/api/v1/custom-attributes/
Example URI
GET /research-common/api/v1/custom-attributes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"dataLength",
"dataTypeCode",
"defaultValue",
"groupName",
"label",
"lookupClass",
"lookupReturn",
"name"
],
"primaryKey": "id"
}Get Blueprint API specification for Custom AttributesGET/research-common/api/v1/custom-attributes/
Example URI
GET /research-common/api/v1/custom-attributes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Custom Attributes.md"
transfer-encoding: chunkedUpdate Custom AttributesPUT/research-common/api/v1/custom-attributes/(key)
Example URI
PUT /research-common/api/v1/custom-attributes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Custom AttributesPUT/research-common/api/v1/custom-attributes/
Example URI
PUT /research-common/api/v1/custom-attributes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Custom AttributesPATCH/research-common/api/v1/custom-attributes/(key)
Example URI
PATCH /research-common/api/v1/custom-attributes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Insert Custom AttributesPOST/research-common/api/v1/custom-attributes/
Example URI
POST /research-common/api/v1/custom-attributes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Custom AttributesPOST/research-common/api/v1/custom-attributes/
Example URI
POST /research-common/api/v1/custom-attributes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"dataLength": "(val)",
"dataTypeCode": "(val)",
"defaultValue": "(val)",
"groupName": "(val)",
"label": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Delete Custom Attributes by KeyDELETE/research-common/api/v1/custom-attributes/(key)
Example URI
DELETE /research-common/api/v1/custom-attributes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Custom AttributesDELETE/research-common/api/v1/custom-attributes/
Example URI
DELETE /research-common/api/v1/custom-attributes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Custom Attributes with MatchingDELETE/research-common/api/v1/custom-attributes/
Example URI
DELETE /research-common/api/v1/custom-attributes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Id. Maximum length is 12.
- dataLength
string(optional)Data Length. Maximum length is 4.
- dataTypeCode
string(optional)Data Type Code. Maximum length is 3.
- defaultValue
string(optional)Default Value. Maximum length is 2000.
- groupName
string(optional)Group Name. Maximum length is 250.
- label
string(optional)Label. Maximum length is 30.
- lookupClass
string(optional)Lookup Class. Maximum length is 100.
- lookupReturn
string(optional)Lookup Return. Maximum length is 30.
- name
string(optional)Name. Maximum length is 30.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Deadline Types ¶
Get Deadline Types by KeyGET/research-common/api/v1/deadline-types/(key)
Example URI
GET /research-common/api/v1/deadline-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Deadline TypesGET/research-common/api/v1/deadline-types/
Example URI
GET /research-common/api/v1/deadline-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Deadline Types with FilteringGET/research-common/api/v1/deadline-types/
Example URI
GET /research-common/api/v1/deadline-types/
URI Parameters
- deadlineTypeCode
string(optional)Deadline Type Code. Maximum length is 1.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Deadline TypesGET/research-common/api/v1/deadline-types/
Example URI
GET /research-common/api/v1/deadline-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"deadlineTypeCode",
"description"
],
"primaryKey": "deadlineTypeCode"
}Get Blueprint API specification for Deadline TypesGET/research-common/api/v1/deadline-types/
Example URI
GET /research-common/api/v1/deadline-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Deadline Types.md"
transfer-encoding: chunkedUpdate Deadline TypesPUT/research-common/api/v1/deadline-types/(key)
Example URI
PUT /research-common/api/v1/deadline-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Deadline TypesPUT/research-common/api/v1/deadline-types/
Example URI
PUT /research-common/api/v1/deadline-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Deadline TypesPATCH/research-common/api/v1/deadline-types/(key)
Example URI
PATCH /research-common/api/v1/deadline-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Deadline TypesPOST/research-common/api/v1/deadline-types/
Example URI
POST /research-common/api/v1/deadline-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Deadline TypesPOST/research-common/api/v1/deadline-types/
Example URI
POST /research-common/api/v1/deadline-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"deadlineTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Deadline Types by KeyDELETE/research-common/api/v1/deadline-types/(key)
Example URI
DELETE /research-common/api/v1/deadline-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Deadline TypesDELETE/research-common/api/v1/deadline-types/
Example URI
DELETE /research-common/api/v1/deadline-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Deadline Types with MatchingDELETE/research-common/api/v1/deadline-types/
Example URI
DELETE /research-common/api/v1/deadline-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- deadlineTypeCode
string(optional)Deadline Type Code. Maximum length is 1.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Degree Types ¶
Get Degree Types by KeyGET/research-common/api/v1/degree-types/(key)
Example URI
GET /research-common/api/v1/degree-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Degree TypesGET/research-common/api/v1/degree-types/
Example URI
GET /research-common/api/v1/degree-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Degree Types with FilteringGET/research-common/api/v1/degree-types/
Example URI
GET /research-common/api/v1/degree-types/
URI Parameters
- code
string(optional)Degree Code. Maximum length is 6.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Degree TypesGET/research-common/api/v1/degree-types/
Example URI
GET /research-common/api/v1/degree-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Degree TypesGET/research-common/api/v1/degree-types/
Example URI
GET /research-common/api/v1/degree-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Degree Types.md"
transfer-encoding: chunkedUpdate Degree TypesPUT/research-common/api/v1/degree-types/(key)
Example URI
PUT /research-common/api/v1/degree-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Degree TypesPUT/research-common/api/v1/degree-types/
Example URI
PUT /research-common/api/v1/degree-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Degree TypesPATCH/research-common/api/v1/degree-types/(key)
Example URI
PATCH /research-common/api/v1/degree-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Degree TypesPOST/research-common/api/v1/degree-types/
Example URI
POST /research-common/api/v1/degree-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Degree TypesPOST/research-common/api/v1/degree-types/
Example URI
POST /research-common/api/v1/degree-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Degree Types by KeyDELETE/research-common/api/v1/degree-types/(key)
Example URI
DELETE /research-common/api/v1/degree-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Degree TypesDELETE/research-common/api/v1/degree-types/
Example URI
DELETE /research-common/api/v1/degree-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Degree Types with MatchingDELETE/research-common/api/v1/degree-types/
Example URI
DELETE /research-common/api/v1/degree-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Degree Code. Maximum length is 6.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Document Accesses ¶
Get Document Accesses by KeyGET/research-common/api/v1/document-accesses/(key)
Example URI
GET /research-common/api/v1/document-accesses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
}Get All Document AccessesGET/research-common/api/v1/document-accesses/
Example URI
GET /research-common/api/v1/document-accesses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Document Accesses with FilteringGET/research-common/api/v1/document-accesses/
Example URI
GET /research-common/api/v1/document-accesses/
URI Parameters
- id
string(optional)Document Access Id. Maximum length is 12.
- documentNumber
string(optional)The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.
- principalId
string(optional)Principal ID. Maximum length is 40.
- roleName
string(optional)Role Name. Maximum length is 80.
- namespaceCode
string(optional)Code identifying the role namespace. Maximum length is 20.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Document AccessesGET/research-common/api/v1/document-accesses/
Example URI
GET /research-common/api/v1/document-accesses/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"documentNumber",
"principalId",
"roleName",
"namespaceCode"
],
"primaryKey": "id"
}Get Blueprint API specification for Document AccessesGET/research-common/api/v1/document-accesses/
Example URI
GET /research-common/api/v1/document-accesses/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Document Accesses.md"
transfer-encoding: chunkedUpdate Document AccessesPUT/research-common/api/v1/document-accesses/(key)
Example URI
PUT /research-common/api/v1/document-accesses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Document AccessesPUT/research-common/api/v1/document-accesses/
Example URI
PUT /research-common/api/v1/document-accesses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Document AccessesPATCH/research-common/api/v1/document-accesses/(key)
Example URI
PATCH /research-common/api/v1/document-accesses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
}Insert Document AccessesPOST/research-common/api/v1/document-accesses/
Example URI
POST /research-common/api/v1/document-accesses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Document AccessesPOST/research-common/api/v1/document-accesses/
Example URI
POST /research-common/api/v1/document-accesses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"principalId": "(val)",
"roleName": "(val)",
"namespaceCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Document Accesses by KeyDELETE/research-common/api/v1/document-accesses/(key)
Example URI
DELETE /research-common/api/v1/document-accesses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Document AccessesDELETE/research-common/api/v1/document-accesses/
Example URI
DELETE /research-common/api/v1/document-accesses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Document Accesses with MatchingDELETE/research-common/api/v1/document-accesses/
Example URI
DELETE /research-common/api/v1/document-accesses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Document Access Id. Maximum length is 12.
- documentNumber
string(optional)The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.
- principalId
string(optional)Principal ID. Maximum length is 40.
- roleName
string(optional)Role Name. Maximum length is 80.
- namespaceCode
string(optional)Code identifying the role namespace. Maximum length is 20.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Document Nextvalues ¶
Get Document Nextvalues by KeyGET/research-common/api/v1/document-nextvalues/(key)
Example URI
GET /research-common/api/v1/document-nextvalues/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
}Get All Document NextvaluesGET/research-common/api/v1/document-nextvalues/
Example URI
GET /research-common/api/v1/document-nextvalues/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
},
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
}
]Get All Document Nextvalues with FilteringGET/research-common/api/v1/document-nextvalues/
Example URI
GET /research-common/api/v1/document-nextvalues/
URI Parameters
- propertyName
string(optional)Property Name. Maximum length is 200.
- documentKey
string(optional)Document Number. Maximum length is 40.
- nextValue
string(optional)Next Value. Maximum length is 12.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
},
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Document NextvaluesGET/research-common/api/v1/document-nextvalues/
Example URI
GET /research-common/api/v1/document-nextvalues/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"propertyName",
"documentKey",
"nextValue"
],
"primaryKey": "documentKey:propertyName"
}Get Blueprint API specification for Document NextvaluesGET/research-common/api/v1/document-nextvalues/
Example URI
GET /research-common/api/v1/document-nextvalues/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Document Nextvalues.md"
transfer-encoding: chunkedUpdate Document NextvaluesPUT/research-common/api/v1/document-nextvalues/(key)
Example URI
PUT /research-common/api/v1/document-nextvalues/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Document NextvaluesPUT/research-common/api/v1/document-nextvalues/
Example URI
PUT /research-common/api/v1/document-nextvalues/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
},
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Document NextvaluesPATCH/research-common/api/v1/document-nextvalues/(key)
Example URI
PATCH /research-common/api/v1/document-nextvalues/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
}Insert Document NextvaluesPOST/research-common/api/v1/document-nextvalues/
Example URI
POST /research-common/api/v1/document-nextvalues/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Document NextvaluesPOST/research-common/api/v1/document-nextvalues/
Example URI
POST /research-common/api/v1/document-nextvalues/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
},
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
},
{
"propertyName": "(val)",
"documentKey": "(val)",
"nextValue": "(val)",
"_primaryKey": "(val)"
}
]Delete Document Nextvalues by KeyDELETE/research-common/api/v1/document-nextvalues/(key)
Example URI
DELETE /research-common/api/v1/document-nextvalues/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Document NextvaluesDELETE/research-common/api/v1/document-nextvalues/
Example URI
DELETE /research-common/api/v1/document-nextvalues/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Document Nextvalues with MatchingDELETE/research-common/api/v1/document-nextvalues/
Example URI
DELETE /research-common/api/v1/document-nextvalues/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- propertyName
string(optional)Property Name. Maximum length is 200.
- documentKey
string(optional)Document Number. Maximum length is 40.
- nextValue
string(optional)Next Value. Maximum length is 12.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Exemption Types ¶
Get Exemption Types by KeyGET/research-common/api/v1/exemption-types/(key)
Example URI
GET /research-common/api/v1/exemption-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
}Get All Exemption TypesGET/research-common/api/v1/exemption-types/
Example URI
GET /research-common/api/v1/exemption-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
}
]Get All Exemption Types with FilteringGET/research-common/api/v1/exemption-types/
Example URI
GET /research-common/api/v1/exemption-types/
URI Parameters
- code
string(optional)Exemption Type. Maximum length is 3.
- description
string(optional)This is the exemption number. Maximum length is 200.
- detailedDescription
string(optional)This is the detailed description of the exemption number. Source is 45cfr46.101(b). Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Exemption TypesGET/research-common/api/v1/exemption-types/
Example URI
GET /research-common/api/v1/exemption-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description",
"detailedDescription"
],
"primaryKey": "code"
}Get Blueprint API specification for Exemption TypesGET/research-common/api/v1/exemption-types/
Example URI
GET /research-common/api/v1/exemption-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Exemption Types.md"
transfer-encoding: chunkedUpdate Exemption TypesPUT/research-common/api/v1/exemption-types/(key)
Example URI
PUT /research-common/api/v1/exemption-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Exemption TypesPUT/research-common/api/v1/exemption-types/
Example URI
PUT /research-common/api/v1/exemption-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Exemption TypesPATCH/research-common/api/v1/exemption-types/(key)
Example URI
PATCH /research-common/api/v1/exemption-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
}Insert Exemption TypesPOST/research-common/api/v1/exemption-types/
Example URI
POST /research-common/api/v1/exemption-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Exemption TypesPOST/research-common/api/v1/exemption-types/
Example URI
POST /research-common/api/v1/exemption-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"detailedDescription": "(val)",
"_primaryKey": "(val)"
}
]Delete Exemption Types by KeyDELETE/research-common/api/v1/exemption-types/(key)
Example URI
DELETE /research-common/api/v1/exemption-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Exemption TypesDELETE/research-common/api/v1/exemption-types/
Example URI
DELETE /research-common/api/v1/exemption-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Exemption Types with MatchingDELETE/research-common/api/v1/exemption-types/
Example URI
DELETE /research-common/api/v1/exemption-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Exemption Type. Maximum length is 3.
- description
string(optional)This is the exemption number. Maximum length is 200.
- detailedDescription
string(optional)This is the detailed description of the exemption number. Source is 45cfr46.101(b). Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Financial Object Code Mappings ¶
Get Financial Object Code Mappings by KeyGET/research-common/api/v1/financial-object-code-mappings/(key)
Example URI
GET /research-common/api/v1/financial-object-code-mappings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Get All Financial Object Code MappingsGET/research-common/api/v1/financial-object-code-mappings/
Example URI
GET /research-common/api/v1/financial-object-code-mappings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Financial Object Code Mappings with FilteringGET/research-common/api/v1/financial-object-code-mappings/
Example URI
GET /research-common/api/v1/financial-object-code-mappings/
URI Parameters
- mappingId
string(optional)- activityTypeCode
string(optional)Activity Type Code. Maximum length is 3.
- financialObjectCode
string(optional)Financial Object Code. Maximum length is 8.
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Financial Object Code MappingsGET/research-common/api/v1/financial-object-code-mappings/
Example URI
GET /research-common/api/v1/financial-object-code-mappings/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"mappingId",
"activityTypeCode",
"financialObjectCode",
"rateClassCode",
"rateTypeCode",
"unitNumber"
],
"primaryKey": "mappingId"
}Get Blueprint API specification for Financial Object Code MappingsGET/research-common/api/v1/financial-object-code-mappings/
Example URI
GET /research-common/api/v1/financial-object-code-mappings/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Financial Object Code Mappings.md"
transfer-encoding: chunkedUpdate Financial Object Code MappingsPUT/research-common/api/v1/financial-object-code-mappings/(key)
Example URI
PUT /research-common/api/v1/financial-object-code-mappings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Financial Object Code MappingsPUT/research-common/api/v1/financial-object-code-mappings/
Example URI
PUT /research-common/api/v1/financial-object-code-mappings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Financial Object Code MappingsPATCH/research-common/api/v1/financial-object-code-mappings/(key)
Example URI
PATCH /research-common/api/v1/financial-object-code-mappings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Insert Financial Object Code MappingsPOST/research-common/api/v1/financial-object-code-mappings/
Example URI
POST /research-common/api/v1/financial-object-code-mappings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Financial Object Code MappingsPOST/research-common/api/v1/financial-object-code-mappings/
Example URI
POST /research-common/api/v1/financial-object-code-mappings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"mappingId": "(val)",
"activityTypeCode": "(val)",
"financialObjectCode": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Financial Object Code Mappings by KeyDELETE/research-common/api/v1/financial-object-code-mappings/(key)
Example URI
DELETE /research-common/api/v1/financial-object-code-mappings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Financial Object Code MappingsDELETE/research-common/api/v1/financial-object-code-mappings/
Example URI
DELETE /research-common/api/v1/financial-object-code-mappings/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Financial Object Code Mappings with MatchingDELETE/research-common/api/v1/financial-object-code-mappings/
Example URI
DELETE /research-common/api/v1/financial-object-code-mappings/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- mappingId
string(optional)- activityTypeCode
string(optional)Activity Type Code. Maximum length is 3.
- financialObjectCode
string(optional)Financial Object Code. Maximum length is 8.
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Formulated Types ¶
Get Formulated Types by KeyGET/research-common/api/v1/formulated-types/(key)
Example URI
GET /research-common/api/v1/formulated-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Formulated TypesGET/research-common/api/v1/formulated-types/
Example URI
GET /research-common/api/v1/formulated-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Formulated Types with FilteringGET/research-common/api/v1/formulated-types/
Example URI
GET /research-common/api/v1/formulated-types/
URI Parameters
- formulatedTypeCode
string(optional)Formulated Type Code. Maximum length is 22.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Formulated TypesGET/research-common/api/v1/formulated-types/
Example URI
GET /research-common/api/v1/formulated-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"formulatedTypeCode",
"description"
],
"primaryKey": "formulatedTypeCode"
}Get Blueprint API specification for Formulated TypesGET/research-common/api/v1/formulated-types/
Example URI
GET /research-common/api/v1/formulated-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Formulated Types.md"
transfer-encoding: chunkedUpdate Formulated TypesPUT/research-common/api/v1/formulated-types/(key)
Example URI
PUT /research-common/api/v1/formulated-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Formulated TypesPUT/research-common/api/v1/formulated-types/
Example URI
PUT /research-common/api/v1/formulated-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Formulated TypesPATCH/research-common/api/v1/formulated-types/(key)
Example URI
PATCH /research-common/api/v1/formulated-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Formulated TypesPOST/research-common/api/v1/formulated-types/
Example URI
POST /research-common/api/v1/formulated-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Formulated TypesPOST/research-common/api/v1/formulated-types/
Example URI
POST /research-common/api/v1/formulated-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"formulatedTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Formulated Types by KeyDELETE/research-common/api/v1/formulated-types/(key)
Example URI
DELETE /research-common/api/v1/formulated-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Formulated TypesDELETE/research-common/api/v1/formulated-types/
Example URI
DELETE /research-common/api/v1/formulated-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Formulated Types with MatchingDELETE/research-common/api/v1/formulated-types/
Example URI
DELETE /research-common/api/v1/formulated-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- formulatedTypeCode
string(optional)Formulated Type Code. Maximum length is 22.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Index Documents into Elasticsearch ¶
These APIs require the Index Elasticsearch Documents permission, which by default is only given to the admin user.
Index Document by Document NumberPOST/research-common/api/v1/index-documents/12345
Example URI
POST /research-common/api/v1/index-documents/12345
URI Parameters
- documentNumber
number(required) Example: 12345The document number of the document to index into Elasticsearch
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
``:Response
202Headers
Content-Type: application/text;charset=UTF-8Body
Indexed document 12345 into ElasticsearchBulk Index All DocumentsPOST/research-common/api/v1/index-documents/
Example URI
POST /research-common/api/v1/index-documents/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
202Headers
Content-Type: application/text;charset=UTF-8Body
Started indexing 3000 documentsInstitute La Rates ¶
Get Institute La Rates by KeyGET/research-common/api/v1/institute-la-rates/(key)
Example URI
GET /research-common/api/v1/institute-la-rates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Institute La RatesGET/research-common/api/v1/institute-la-rates/
Example URI
GET /research-common/api/v1/institute-la-rates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Institute La Rates with FilteringGET/research-common/api/v1/institute-la-rates/
Example URI
GET /research-common/api/v1/institute-la-rates/
URI Parameters
- fiscalYear
string(optional)Fiscal Year. Maximum length is 4.
- onOffCampusFlag
string(optional)On Off CampusContractContract Flag. Maximum length is 1.
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
- startDate
string(optional)Start Date. Maximum length is 10.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
- instituteRate
string(optional)Rate. Maximum length is 5.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Institute La RatesGET/research-common/api/v1/institute-la-rates/
Example URI
GET /research-common/api/v1/institute-la-rates/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"fiscalYear",
"onOffCampusFlag",
"rateClassCode",
"rateTypeCode",
"startDate",
"unitNumber",
"instituteRate",
"active"
],
"primaryKey": "fiscalYear:onOffCampusFlag:rateClassCode:rateTypeCode:startDate:unitNumber"
}Get Blueprint API specification for Institute La RatesGET/research-common/api/v1/institute-la-rates/
Example URI
GET /research-common/api/v1/institute-la-rates/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Institute La Rates.md"
transfer-encoding: chunkedUpdate Institute La RatesPUT/research-common/api/v1/institute-la-rates/(key)
Example URI
PUT /research-common/api/v1/institute-la-rates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Institute La RatesPUT/research-common/api/v1/institute-la-rates/
Example URI
PUT /research-common/api/v1/institute-la-rates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Institute La RatesPATCH/research-common/api/v1/institute-la-rates/(key)
Example URI
PATCH /research-common/api/v1/institute-la-rates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Institute La RatesPOST/research-common/api/v1/institute-la-rates/
Example URI
POST /research-common/api/v1/institute-la-rates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Institute La RatesPOST/research-common/api/v1/institute-la-rates/
Example URI
POST /research-common/api/v1/institute-la-rates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"fiscalYear": "(val)",
"onOffCampusFlag": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"startDate": "(val)",
"unitNumber": "(val)",
"instituteRate": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Institute La Rates by KeyDELETE/research-common/api/v1/institute-la-rates/(key)
Example URI
DELETE /research-common/api/v1/institute-la-rates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Institute La RatesDELETE/research-common/api/v1/institute-la-rates/
Example URI
DELETE /research-common/api/v1/institute-la-rates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Institute La Rates with MatchingDELETE/research-common/api/v1/institute-la-rates/
Example URI
DELETE /research-common/api/v1/institute-la-rates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- fiscalYear
string(optional)Fiscal Year. Maximum length is 4.
- onOffCampusFlag
string(optional)On Off CampusContractContract Flag. Maximum length is 1.
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
- startDate
string(optional)Start Date. Maximum length is 10.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
- instituteRate
string(optional)Rate. Maximum length is 5.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Investigator Credit Types ¶
Get Investigator Credit Types by KeyGET/research-common/api/v1/investigator-credit-types/(key)
Example URI
GET /research-common/api/v1/investigator-credit-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Investigator Credit TypesGET/research-common/api/v1/investigator-credit-types/
Example URI
GET /research-common/api/v1/investigator-credit-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Investigator Credit Types with FilteringGET/research-common/api/v1/investigator-credit-types/
Example URI
GET /research-common/api/v1/investigator-credit-types/
URI Parameters
- code
string(optional)Investigator Credit Type Code. Maximum length is 3.
- addsToHundred
string(optional)Adds to Hundred. Maximum length is 1.
- active
string(optional)Is Active. Maximum length is 1.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Investigator Credit TypesGET/research-common/api/v1/investigator-credit-types/
Example URI
GET /research-common/api/v1/investigator-credit-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"addsToHundred",
"active",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Investigator Credit TypesGET/research-common/api/v1/investigator-credit-types/
Example URI
GET /research-common/api/v1/investigator-credit-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Investigator Credit Types.md"
transfer-encoding: chunkedUpdate Investigator Credit TypesPUT/research-common/api/v1/investigator-credit-types/(key)
Example URI
PUT /research-common/api/v1/investigator-credit-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Investigator Credit TypesPUT/research-common/api/v1/investigator-credit-types/
Example URI
PUT /research-common/api/v1/investigator-credit-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Investigator Credit TypesPATCH/research-common/api/v1/investigator-credit-types/(key)
Example URI
PATCH /research-common/api/v1/investigator-credit-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Investigator Credit TypesPOST/research-common/api/v1/investigator-credit-types/
Example URI
POST /research-common/api/v1/investigator-credit-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Investigator Credit TypesPOST/research-common/api/v1/investigator-credit-types/
Example URI
POST /research-common/api/v1/investigator-credit-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"addsToHundred": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Investigator Credit Types by KeyDELETE/research-common/api/v1/investigator-credit-types/(key)
Example URI
DELETE /research-common/api/v1/investigator-credit-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Investigator Credit TypesDELETE/research-common/api/v1/investigator-credit-types/
Example URI
DELETE /research-common/api/v1/investigator-credit-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Investigator Credit Types with MatchingDELETE/research-common/api/v1/investigator-credit-types/
Example URI
DELETE /research-common/api/v1/investigator-credit-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Investigator Credit Type Code. Maximum length is 3.
- addsToHundred
string(optional)Adds to Hundred. Maximum length is 1.
- active
string(optional)Is Active. Maximum length is 1.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Job Codes ¶
Get Job Codes by KeyGET/research-common/api/v1/job-codes/(key)
Example URI
GET /research-common/api/v1/job-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
}Get All Job CodesGET/research-common/api/v1/job-codes/
Example URI
GET /research-common/api/v1/job-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
},
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
}
]Get All Job Codes with FilteringGET/research-common/api/v1/job-codes/
Example URI
GET /research-common/api/v1/job-codes/
URI Parameters
- jobCode
string(optional)Job Code. Maximum length is 6.
- jobTitle
string(optional)Job Title. Maximum length is 50.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
},
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Job CodesGET/research-common/api/v1/job-codes/
Example URI
GET /research-common/api/v1/job-codes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"jobCode",
"jobTitle"
],
"primaryKey": "jobCode"
}Get Blueprint API specification for Job CodesGET/research-common/api/v1/job-codes/
Example URI
GET /research-common/api/v1/job-codes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Job Codes.md"
transfer-encoding: chunkedUpdate Job CodesPUT/research-common/api/v1/job-codes/(key)
Example URI
PUT /research-common/api/v1/job-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Job CodesPUT/research-common/api/v1/job-codes/
Example URI
PUT /research-common/api/v1/job-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
},
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Job CodesPATCH/research-common/api/v1/job-codes/(key)
Example URI
PATCH /research-common/api/v1/job-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
}Insert Job CodesPOST/research-common/api/v1/job-codes/
Example URI
POST /research-common/api/v1/job-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Job CodesPOST/research-common/api/v1/job-codes/
Example URI
POST /research-common/api/v1/job-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
},
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
},
{
"jobCode": "(val)",
"jobTitle": "(val)",
"_primaryKey": "(val)"
}
]Delete Job Codes by KeyDELETE/research-common/api/v1/job-codes/(key)
Example URI
DELETE /research-common/api/v1/job-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Job CodesDELETE/research-common/api/v1/job-codes/
Example URI
DELETE /research-common/api/v1/job-codes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Job Codes with MatchingDELETE/research-common/api/v1/job-codes/
Example URI
DELETE /research-common/api/v1/job-codes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- jobCode
string(optional)Job Code. Maximum length is 6.
- jobTitle
string(optional)Job Title. Maximum length is 50.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Kc Krms Term Function Params ¶
Get Kc Krms Term Function Params by KeyGET/research-common/api/v1/kc-krms-term-function-params/(key)
Example URI
GET /research-common/api/v1/kc-krms-term-function-params/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
}Get All Kc Krms Term Function ParamsGET/research-common/api/v1/kc-krms-term-function-params/
Example URI
GET /research-common/api/v1/kc-krms-term-function-params/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
},
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
}
]Get All Kc Krms Term Function Params with FilteringGET/research-common/api/v1/kc-krms-term-function-params/
Example URI
GET /research-common/api/v1/kc-krms-term-function-params/
URI Parameters
- kcKrmsTermFunctionParamId
string(optional)Kc Krms Term Fun Param Spec Id. Maximum length is 22.
- kcKrmsTermFunctionId
string(optional)Kc Krms Term Function Id. Maximum length is 22.
- paramName
string(optional)Param Name. Maximum length is 40.
- paramType
string(optional)Param Type. Maximum length is 100.
- paramOrder
string(optional)Param Order. Maximum length is 22.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
},
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Kc Krms Term Function ParamsGET/research-common/api/v1/kc-krms-term-function-params/
Example URI
GET /research-common/api/v1/kc-krms-term-function-params/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"kcKrmsTermFunctionParamId",
"kcKrmsTermFunctionId",
"paramName",
"paramType",
"paramOrder"
],
"primaryKey": "kcKrmsTermFunctionParamId"
}Get Blueprint API specification for Kc Krms Term Function ParamsGET/research-common/api/v1/kc-krms-term-function-params/
Example URI
GET /research-common/api/v1/kc-krms-term-function-params/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kc Krms Term Function Params.md"
transfer-encoding: chunkedUpdate Kc Krms Term Function ParamsPUT/research-common/api/v1/kc-krms-term-function-params/(key)
Example URI
PUT /research-common/api/v1/kc-krms-term-function-params/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Kc Krms Term Function ParamsPUT/research-common/api/v1/kc-krms-term-function-params/
Example URI
PUT /research-common/api/v1/kc-krms-term-function-params/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
},
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Kc Krms Term Function ParamsPATCH/research-common/api/v1/kc-krms-term-function-params/(key)
Example URI
PATCH /research-common/api/v1/kc-krms-term-function-params/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
}Insert Kc Krms Term Function ParamsPOST/research-common/api/v1/kc-krms-term-function-params/
Example URI
POST /research-common/api/v1/kc-krms-term-function-params/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Kc Krms Term Function ParamsPOST/research-common/api/v1/kc-krms-term-function-params/
Example URI
POST /research-common/api/v1/kc-krms-term-function-params/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
},
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
},
{
"kcKrmsTermFunctionParamId": "(val)",
"kcKrmsTermFunctionId": "(val)",
"paramName": "(val)",
"paramType": "(val)",
"paramOrder": "(val)",
"_primaryKey": "(val)"
}
]Delete Kc Krms Term Function Params by KeyDELETE/research-common/api/v1/kc-krms-term-function-params/(key)
Example URI
DELETE /research-common/api/v1/kc-krms-term-function-params/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Kc Krms Term Function ParamsDELETE/research-common/api/v1/kc-krms-term-function-params/
Example URI
DELETE /research-common/api/v1/kc-krms-term-function-params/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Kc Krms Term Function Params with MatchingDELETE/research-common/api/v1/kc-krms-term-function-params/
Example URI
DELETE /research-common/api/v1/kc-krms-term-function-params/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- kcKrmsTermFunctionParamId
string(optional)Kc Krms Term Fun Param Spec Id. Maximum length is 22.
- kcKrmsTermFunctionId
string(optional)Kc Krms Term Function Id. Maximum length is 22.
- paramName
string(optional)Param Name. Maximum length is 40.
- paramType
string(optional)Param Type. Maximum length is 100.
- paramOrder
string(optional)Param Order. Maximum length is 22.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Kc Krms Term Functions ¶
Get Kc Krms Term Functions by KeyGET/research-common/api/v1/kc-krms-term-functions/(key)
Example URI
GET /research-common/api/v1/kc-krms-term-functions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
}Get All Kc Krms Term FunctionsGET/research-common/api/v1/kc-krms-term-functions/
Example URI
GET /research-common/api/v1/kc-krms-term-functions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
},
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
}
]Get All Kc Krms Term Functions with FilteringGET/research-common/api/v1/kc-krms-term-functions/
Example URI
GET /research-common/api/v1/kc-krms-term-functions/
URI Parameters
- kcKrmsTermFunctionId
string(optional)Kc Krms Term Function Id. Maximum length is 22.
- krmsTermName
string(optional)Krms Term Id. Maximum length is 20.
- description
string(optional)Description. Maximum length is 200.
- returnType
string(optional)Return Type. Maximum length is 100.
- functionType
string(optional)Function Type. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
},
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Kc Krms Term FunctionsGET/research-common/api/v1/kc-krms-term-functions/
Example URI
GET /research-common/api/v1/kc-krms-term-functions/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"kcKrmsTermFunctionId",
"krmsTermName",
"description",
"returnType",
"functionType"
],
"primaryKey": "kcKrmsTermFunctionId"
}Get Blueprint API specification for Kc Krms Term FunctionsGET/research-common/api/v1/kc-krms-term-functions/
Example URI
GET /research-common/api/v1/kc-krms-term-functions/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kc Krms Term Functions.md"
transfer-encoding: chunkedUpdate Kc Krms Term FunctionsPUT/research-common/api/v1/kc-krms-term-functions/(key)
Example URI
PUT /research-common/api/v1/kc-krms-term-functions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Kc Krms Term FunctionsPUT/research-common/api/v1/kc-krms-term-functions/
Example URI
PUT /research-common/api/v1/kc-krms-term-functions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
},
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Kc Krms Term FunctionsPATCH/research-common/api/v1/kc-krms-term-functions/(key)
Example URI
PATCH /research-common/api/v1/kc-krms-term-functions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
}Insert Kc Krms Term FunctionsPOST/research-common/api/v1/kc-krms-term-functions/
Example URI
POST /research-common/api/v1/kc-krms-term-functions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Kc Krms Term FunctionsPOST/research-common/api/v1/kc-krms-term-functions/
Example URI
POST /research-common/api/v1/kc-krms-term-functions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
},
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
},
{
"kcKrmsTermFunctionId": "(val)",
"krmsTermName": "(val)",
"description": "(val)",
"returnType": "(val)",
"functionType": "(val)",
"_primaryKey": "(val)"
}
]Delete Kc Krms Term Functions by KeyDELETE/research-common/api/v1/kc-krms-term-functions/(key)
Example URI
DELETE /research-common/api/v1/kc-krms-term-functions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Kc Krms Term FunctionsDELETE/research-common/api/v1/kc-krms-term-functions/
Example URI
DELETE /research-common/api/v1/kc-krms-term-functions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Kc Krms Term Functions with MatchingDELETE/research-common/api/v1/kc-krms-term-functions/
Example URI
DELETE /research-common/api/v1/kc-krms-term-functions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- kcKrmsTermFunctionId
string(optional)Kc Krms Term Function Id. Maximum length is 22.
- krmsTermName
string(optional)Krms Term Id. Maximum length is 20.
- description
string(optional)Description. Maximum length is 200.
- returnType
string(optional)Return Type. Maximum length is 100.
- functionType
string(optional)Function Type. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Kc Notifications ¶
Get Kc Notifications by KeyGET/research-common/api/v1/kc-notifications/(key)
Example URI
GET /research-common/api/v1/kc-notifications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
}Get All Kc NotificationsGET/research-common/api/v1/kc-notifications/
Example URI
GET /research-common/api/v1/kc-notifications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
},
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
}
]Get All Kc Notifications with FilteringGET/research-common/api/v1/kc-notifications/
Example URI
GET /research-common/api/v1/kc-notifications/
URI Parameters
- notificationId
string(optional)Notification Id. Maximum length is 20.
- notificationTypeId
string(optional)Notification Type. Maximum length is 6.
- documentNumber
string(optional)Document Number. Maximum length is 10.
- subject
string(optional)Subject. Maximum length is 1000.
- message
string(optional)Message. Maximum length is 4000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
},
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Kc NotificationsGET/research-common/api/v1/kc-notifications/
Example URI
GET /research-common/api/v1/kc-notifications/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"notificationId",
"notificationTypeId",
"documentNumber",
"subject",
"message"
],
"primaryKey": "notificationId"
}Get Blueprint API specification for Kc NotificationsGET/research-common/api/v1/kc-notifications/
Example URI
GET /research-common/api/v1/kc-notifications/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kc Notifications.md"
transfer-encoding: chunkedUpdate Kc NotificationsPUT/research-common/api/v1/kc-notifications/(key)
Example URI
PUT /research-common/api/v1/kc-notifications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Kc NotificationsPUT/research-common/api/v1/kc-notifications/
Example URI
PUT /research-common/api/v1/kc-notifications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
},
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Kc NotificationsPATCH/research-common/api/v1/kc-notifications/(key)
Example URI
PATCH /research-common/api/v1/kc-notifications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
}Insert Kc NotificationsPOST/research-common/api/v1/kc-notifications/
Example URI
POST /research-common/api/v1/kc-notifications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Kc NotificationsPOST/research-common/api/v1/kc-notifications/
Example URI
POST /research-common/api/v1/kc-notifications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
},
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
},
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"subject": "(val)",
"message": "(val)",
"_primaryKey": "(val)"
}
]Delete Kc Notifications by KeyDELETE/research-common/api/v1/kc-notifications/(key)
Example URI
DELETE /research-common/api/v1/kc-notifications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Kc NotificationsDELETE/research-common/api/v1/kc-notifications/
Example URI
DELETE /research-common/api/v1/kc-notifications/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Kc Notifications with MatchingDELETE/research-common/api/v1/kc-notifications/
Example URI
DELETE /research-common/api/v1/kc-notifications/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- notificationId
string(optional)Notification Id. Maximum length is 20.
- notificationTypeId
string(optional)Notification Type. Maximum length is 6.
- documentNumber
string(optional)Document Number. Maximum length is 10.
- subject
string(optional)Subject. Maximum length is 1000.
- message
string(optional)Message. Maximum length is 4000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Kc Person Extended Attributes ¶
Get Kc Person Extended Attributes by KeyGET/research-common/api/v1/kc-person-extended-attributes/(key)
Example URI
GET /research-common/api/v1/kc-person-extended-attributes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
}Get All Kc Person Extended AttributesGET/research-common/api/v1/kc-person-extended-attributes/
Example URI
GET /research-common/api/v1/kc-person-extended-attributes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
}
]Get All Kc Person Extended Attributes with FilteringGET/research-common/api/v1/kc-person-extended-attributes/
Example URI
GET /research-common/api/v1/kc-person-extended-attributes/
URI Parameters
- personId
string(optional)KcPersonExtendedAttributes Id. Maximum length is 40.
- ageByFiscalYear
string(optional)Age by Fiscal Year. Maximum length is 3.
- race
string(optional)Race. Maximum length is 30.
- educationLevel
string(optional)Education Level. Maximum length is 30.
- degree
string(optional)Degree. Maximum length is 11.
- major
string(optional)Major. Maximum length is 30.
- handicappedFlag
string(optional)Is Handicapped. Maximum length is 1.
- handicapType
string(optional)Handicap Type. Maximum length is 30.
- veteranFlag
string(optional)Veteran. Maximum length is 1.
- veteranType
string(optional)Veteran Type. Maximum length is 30.
- visaCode
string(optional)Visa Code. Maximum length is 20.
- visaType
string(optional)Visa Type. Maximum length is 30.
- visaRenewalDate
string(optional)Visa Renewal Date. Maximum length is 10.
- hasVisa
string(optional)Has Visa. Maximum length is 1.
- officeLocation
string(optional)Office Location. Maximum length is 30.
- secondaryOfficeLocation
string(optional)Secondary Office Location. Maximum length is 30.
- school
string(optional)School. Maximum length is 50.
- yearGraduated
string(optional)Year Graduated. Maximum length is 30.
- directoryDepartment
string(optional)Directory Department. Maximum length is 30.
- primaryTitle
string(optional)PrimaryTitle. Maximum length is 51.
- directoryTitle
string(optional)Directory Title. Maximum length is 50.
- vacationAccrualFlag
string(optional)Is Vacation Accrual. Maximum length is 1.
- onSabbaticalFlag
string(optional)Is on Sabbatical. Maximum length is 1.
- idProvided
string(optional)Id Provided. Maximum length is 30.
- idVerified
string(optional)Id Verified. Maximum length is 30.
- county
string(optional)County. Maximum length is 30.
- citizenshipTypeCode
string(optional)Citzenship Type. Maximum length is 3.
- multiCampusPrincipalId
string(optional)Multi-Campus Principal Id. Maximum length is 40.
- multiCampusPrincipalName
string(optional)Multi-Campus Principal Name. Maximum length is 100.
- salaryAnniversaryDate
string(optional)Salary Anniversary Date. Maximum length is 10.
- eraCommonUserName
string(optional)Era Commons User Name. Maximum length is 20.
- nsfId
string(optional)NSF ID. Maximum length is 9.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Kc Person Extended AttributesGET/research-common/api/v1/kc-person-extended-attributes/
Example URI
GET /research-common/api/v1/kc-person-extended-attributes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"personId",
"ageByFiscalYear",
"race",
"educationLevel",
"degree",
"major",
"handicappedFlag",
"handicapType",
"veteranFlag",
"veteranType",
"visaCode",
"visaType",
"visaRenewalDate",
"hasVisa",
"officeLocation",
"secondaryOfficeLocation",
"school",
"yearGraduated",
"directoryDepartment",
"primaryTitle",
"directoryTitle",
"vacationAccrualFlag",
"onSabbaticalFlag",
"idProvided",
"idVerified",
"county",
"citizenshipTypeCode",
"multiCampusPrincipalId",
"multiCampusPrincipalName",
"salaryAnniversaryDate",
"eraCommonUserName",
"nsfId"
],
"primaryKey": "personId"
}Get Blueprint API specification for Kc Person Extended AttributesGET/research-common/api/v1/kc-person-extended-attributes/
Example URI
GET /research-common/api/v1/kc-person-extended-attributes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kc Person Extended Attributes.md"
transfer-encoding: chunkedUpdate Kc Person Extended AttributesPUT/research-common/api/v1/kc-person-extended-attributes/(key)
Example URI
PUT /research-common/api/v1/kc-person-extended-attributes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Kc Person Extended AttributesPUT/research-common/api/v1/kc-person-extended-attributes/
Example URI
PUT /research-common/api/v1/kc-person-extended-attributes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Kc Person Extended AttributesPATCH/research-common/api/v1/kc-person-extended-attributes/(key)
Example URI
PATCH /research-common/api/v1/kc-person-extended-attributes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
}Insert Kc Person Extended AttributesPOST/research-common/api/v1/kc-person-extended-attributes/
Example URI
POST /research-common/api/v1/kc-person-extended-attributes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Kc Person Extended AttributesPOST/research-common/api/v1/kc-person-extended-attributes/
Example URI
POST /research-common/api/v1/kc-person-extended-attributes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"ageByFiscalYear": "(val)",
"race": "(val)",
"educationLevel": "(val)",
"degree": "(val)",
"major": "(val)",
"handicappedFlag": "(val)",
"handicapType": "(val)",
"veteranFlag": "(val)",
"veteranType": "(val)",
"visaCode": "(val)",
"visaType": "(val)",
"visaRenewalDate": "(val)",
"hasVisa": "(val)",
"officeLocation": "(val)",
"secondaryOfficeLocation": "(val)",
"school": "(val)",
"yearGraduated": "(val)",
"directoryDepartment": "(val)",
"primaryTitle": "(val)",
"directoryTitle": "(val)",
"vacationAccrualFlag": "(val)",
"onSabbaticalFlag": "(val)",
"idProvided": "(val)",
"idVerified": "(val)",
"county": "(val)",
"citizenshipTypeCode": "(val)",
"multiCampusPrincipalId": "(val)",
"multiCampusPrincipalName": "(val)",
"salaryAnniversaryDate": "(val)",
"eraCommonUserName": "(val)",
"nsfId": "(val)",
"_primaryKey": "(val)"
}
]Delete Kc Person Extended Attributes by KeyDELETE/research-common/api/v1/kc-person-extended-attributes/(key)
Example URI
DELETE /research-common/api/v1/kc-person-extended-attributes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Kc Person Extended AttributesDELETE/research-common/api/v1/kc-person-extended-attributes/
Example URI
DELETE /research-common/api/v1/kc-person-extended-attributes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Kc Person Extended Attributes with MatchingDELETE/research-common/api/v1/kc-person-extended-attributes/
Example URI
DELETE /research-common/api/v1/kc-person-extended-attributes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- personId
string(optional)KcPersonExtendedAttributes Id. Maximum length is 40.
- ageByFiscalYear
string(optional)Age by Fiscal Year. Maximum length is 3.
- race
string(optional)Race. Maximum length is 30.
- educationLevel
string(optional)Education Level. Maximum length is 30.
- degree
string(optional)Degree. Maximum length is 11.
- major
string(optional)Major. Maximum length is 30.
- handicappedFlag
string(optional)Is Handicapped. Maximum length is 1.
- handicapType
string(optional)Handicap Type. Maximum length is 30.
- veteranFlag
string(optional)Veteran. Maximum length is 1.
- veteranType
string(optional)Veteran Type. Maximum length is 30.
- visaCode
string(optional)Visa Code. Maximum length is 20.
- visaType
string(optional)Visa Type. Maximum length is 30.
- visaRenewalDate
string(optional)Visa Renewal Date. Maximum length is 10.
- hasVisa
string(optional)Has Visa. Maximum length is 1.
- officeLocation
string(optional)Office Location. Maximum length is 30.
- secondaryOfficeLocation
string(optional)Secondary Office Location. Maximum length is 30.
- school
string(optional)School. Maximum length is 50.
- yearGraduated
string(optional)Year Graduated. Maximum length is 30.
- directoryDepartment
string(optional)Directory Department. Maximum length is 30.
- primaryTitle
string(optional)PrimaryTitle. Maximum length is 51.
- directoryTitle
string(optional)Directory Title. Maximum length is 50.
- vacationAccrualFlag
string(optional)Is Vacation Accrual. Maximum length is 1.
- onSabbaticalFlag
string(optional)Is on Sabbatical. Maximum length is 1.
- idProvided
string(optional)Id Provided. Maximum length is 30.
- idVerified
string(optional)Id Verified. Maximum length is 30.
- county
string(optional)County. Maximum length is 30.
- citizenshipTypeCode
string(optional)Citzenship Type. Maximum length is 3.
- multiCampusPrincipalId
string(optional)Multi-Campus Principal Id. Maximum length is 40.
- multiCampusPrincipalName
string(optional)Multi-Campus Principal Name. Maximum length is 100.
- salaryAnniversaryDate
string(optional)Salary Anniversary Date. Maximum length is 10.
- eraCommonUserName
string(optional)Era Commons User Name. Maximum length is 20.
- nsfId
string(optional)NSF ID. Maximum length is 9.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Mail By Entries ¶
Get Mail By Entries by KeyGET/research-common/api/v1/mail-by-entries/(key)
Example URI
GET /research-common/api/v1/mail-by-entries/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Mail By EntriesGET/research-common/api/v1/mail-by-entries/
Example URI
GET /research-common/api/v1/mail-by-entries/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Mail By Entries with FilteringGET/research-common/api/v1/mail-by-entries/
Example URI
GET /research-common/api/v1/mail-by-entries/
URI Parameters
- mailByCode
string(optional)Mail By. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Mail By EntriesGET/research-common/api/v1/mail-by-entries/
Example URI
GET /research-common/api/v1/mail-by-entries/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"mailByCode",
"description"
],
"primaryKey": "mailByCode"
}Get Blueprint API specification for Mail By EntriesGET/research-common/api/v1/mail-by-entries/
Example URI
GET /research-common/api/v1/mail-by-entries/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Mail By Entries.md"
transfer-encoding: chunkedUpdate Mail By EntriesPUT/research-common/api/v1/mail-by-entries/(key)
Example URI
PUT /research-common/api/v1/mail-by-entries/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Mail By EntriesPUT/research-common/api/v1/mail-by-entries/
Example URI
PUT /research-common/api/v1/mail-by-entries/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Mail By EntriesPATCH/research-common/api/v1/mail-by-entries/(key)
Example URI
PATCH /research-common/api/v1/mail-by-entries/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Mail By EntriesPOST/research-common/api/v1/mail-by-entries/
Example URI
POST /research-common/api/v1/mail-by-entries/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Mail By EntriesPOST/research-common/api/v1/mail-by-entries/
Example URI
POST /research-common/api/v1/mail-by-entries/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mailByCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Mail By Entries by KeyDELETE/research-common/api/v1/mail-by-entries/(key)
Example URI
DELETE /research-common/api/v1/mail-by-entries/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Mail By EntriesDELETE/research-common/api/v1/mail-by-entries/
Example URI
DELETE /research-common/api/v1/mail-by-entries/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Mail By Entries with MatchingDELETE/research-common/api/v1/mail-by-entries/
Example URI
DELETE /research-common/api/v1/mail-by-entries/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- mailByCode
string(optional)Mail By. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Mail Types ¶
Get Mail Types by KeyGET/research-common/api/v1/mail-types/(key)
Example URI
GET /research-common/api/v1/mail-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Mail TypesGET/research-common/api/v1/mail-types/
Example URI
GET /research-common/api/v1/mail-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Mail Types with FilteringGET/research-common/api/v1/mail-types/
Example URI
GET /research-common/api/v1/mail-types/
URI Parameters
- mailType
string(optional)Mail Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Mail TypesGET/research-common/api/v1/mail-types/
Example URI
GET /research-common/api/v1/mail-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"mailType",
"description"
],
"primaryKey": "mailType"
}Get Blueprint API specification for Mail TypesGET/research-common/api/v1/mail-types/
Example URI
GET /research-common/api/v1/mail-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Mail Types.md"
transfer-encoding: chunkedUpdate Mail TypesPUT/research-common/api/v1/mail-types/(key)
Example URI
PUT /research-common/api/v1/mail-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Mail TypesPUT/research-common/api/v1/mail-types/
Example URI
PUT /research-common/api/v1/mail-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Mail TypesPATCH/research-common/api/v1/mail-types/(key)
Example URI
PATCH /research-common/api/v1/mail-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Mail TypesPOST/research-common/api/v1/mail-types/
Example URI
POST /research-common/api/v1/mail-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Mail TypesPOST/research-common/api/v1/mail-types/
Example URI
POST /research-common/api/v1/mail-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"mailType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Mail Types by KeyDELETE/research-common/api/v1/mail-types/(key)
Example URI
DELETE /research-common/api/v1/mail-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Mail TypesDELETE/research-common/api/v1/mail-types/
Example URI
DELETE /research-common/api/v1/mail-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Mail Types with MatchingDELETE/research-common/api/v1/mail-types/
Example URI
DELETE /research-common/api/v1/mail-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- mailType
string(optional)Mail Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Membership Roles ¶
Get Membership Roles by KeyGET/research-common/api/v1/membership-roles/(key)
Example URI
GET /research-common/api/v1/membership-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Membership RolesGET/research-common/api/v1/membership-roles/
Example URI
GET /research-common/api/v1/membership-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Membership Roles with FilteringGET/research-common/api/v1/membership-roles/
Example URI
GET /research-common/api/v1/membership-roles/
URI Parameters
- membershipRoleCode
string(optional)Membership Role Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- committeeTypeCode
string(optional)Committee Type Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Membership RolesGET/research-common/api/v1/membership-roles/
Example URI
GET /research-common/api/v1/membership-roles/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"membershipRoleCode",
"description",
"committeeTypeCode"
],
"primaryKey": "membershipRoleCode"
}Get Blueprint API specification for Membership RolesGET/research-common/api/v1/membership-roles/
Example URI
GET /research-common/api/v1/membership-roles/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Membership Roles.md"
transfer-encoding: chunkedUpdate Membership RolesPUT/research-common/api/v1/membership-roles/(key)
Example URI
PUT /research-common/api/v1/membership-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Membership RolesPUT/research-common/api/v1/membership-roles/
Example URI
PUT /research-common/api/v1/membership-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Membership RolesPATCH/research-common/api/v1/membership-roles/(key)
Example URI
PATCH /research-common/api/v1/membership-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Membership RolesPOST/research-common/api/v1/membership-roles/
Example URI
POST /research-common/api/v1/membership-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Membership RolesPOST/research-common/api/v1/membership-roles/
Example URI
POST /research-common/api/v1/membership-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"membershipRoleCode": "(val)",
"description": "(val)",
"committeeTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Membership Roles by KeyDELETE/research-common/api/v1/membership-roles/(key)
Example URI
DELETE /research-common/api/v1/membership-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Membership RolesDELETE/research-common/api/v1/membership-roles/
Example URI
DELETE /research-common/api/v1/membership-roles/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Membership Roles with MatchingDELETE/research-common/api/v1/membership-roles/
Example URI
DELETE /research-common/api/v1/membership-roles/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- membershipRoleCode
string(optional)Membership Role Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- committeeTypeCode
string(optional)Committee Type Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Message Of The Days ¶
Get Message Of The Days by KeyGET/research-common/api/v1/message-of-the-days/(key)
Example URI
GET /research-common/api/v1/message-of-the-days/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
}Get All Message Of The DaysGET/research-common/api/v1/message-of-the-days/
Example URI
GET /research-common/api/v1/message-of-the-days/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
},
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
}
]Get All Message Of The Days with FilteringGET/research-common/api/v1/message-of-the-days/
Example URI
GET /research-common/api/v1/message-of-the-days/
URI Parameters
- messageOfTheDayId
string(optional)Message Of The Day Id. Maximum length is 22.
- message
string(optional)Message. Maximum length is 4000.
- active
string(optional)active. Maximum length is 1.
- displayOrder
string(optional)Display Order. Maximum length is 22.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
},
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Message Of The DaysGET/research-common/api/v1/message-of-the-days/
Example URI
GET /research-common/api/v1/message-of-the-days/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"messageOfTheDayId",
"message",
"active",
"displayOrder"
],
"primaryKey": "messageOfTheDayId"
}Get Blueprint API specification for Message Of The DaysGET/research-common/api/v1/message-of-the-days/
Example URI
GET /research-common/api/v1/message-of-the-days/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Message Of The Days.md"
transfer-encoding: chunkedUpdate Message Of The DaysPUT/research-common/api/v1/message-of-the-days/(key)
Example URI
PUT /research-common/api/v1/message-of-the-days/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Message Of The DaysPUT/research-common/api/v1/message-of-the-days/
Example URI
PUT /research-common/api/v1/message-of-the-days/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
},
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Message Of The DaysPATCH/research-common/api/v1/message-of-the-days/(key)
Example URI
PATCH /research-common/api/v1/message-of-the-days/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
}Insert Message Of The DaysPOST/research-common/api/v1/message-of-the-days/
Example URI
POST /research-common/api/v1/message-of-the-days/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Message Of The DaysPOST/research-common/api/v1/message-of-the-days/
Example URI
POST /research-common/api/v1/message-of-the-days/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
},
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
},
{
"messageOfTheDayId": "(val)",
"message": "(val)",
"active": "(val)",
"displayOrder": "(val)",
"_primaryKey": "(val)"
}
]Delete Message Of The Days by KeyDELETE/research-common/api/v1/message-of-the-days/(key)
Example URI
DELETE /research-common/api/v1/message-of-the-days/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Message Of The DaysDELETE/research-common/api/v1/message-of-the-days/
Example URI
DELETE /research-common/api/v1/message-of-the-days/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Message Of The Days with MatchingDELETE/research-common/api/v1/message-of-the-days/
Example URI
DELETE /research-common/api/v1/message-of-the-days/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- messageOfTheDayId
string(optional)Message Of The Day Id. Maximum length is 22.
- message
string(optional)Message. Maximum length is 4000.
- active
string(optional)active. Maximum length is 1.
- displayOrder
string(optional)Display Order. Maximum length is 22.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Minute Entry Types ¶
Get Minute Entry Types by KeyGET/research-common/api/v1/minute-entry-types/(key)
Example URI
GET /research-common/api/v1/minute-entry-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Minute Entry TypesGET/research-common/api/v1/minute-entry-types/
Example URI
GET /research-common/api/v1/minute-entry-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Minute Entry Types with FilteringGET/research-common/api/v1/minute-entry-types/
Example URI
GET /research-common/api/v1/minute-entry-types/
URI Parameters
- minuteEntryTypeCode
string(optional)Minute Entry Type Code. Maximum length is 3.
- sortId
string(optional)Sort Id. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Minute Entry TypesGET/research-common/api/v1/minute-entry-types/
Example URI
GET /research-common/api/v1/minute-entry-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"minuteEntryTypeCode",
"sortId",
"description"
],
"primaryKey": "minuteEntryTypeCode"
}Get Blueprint API specification for Minute Entry TypesGET/research-common/api/v1/minute-entry-types/
Example URI
GET /research-common/api/v1/minute-entry-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Minute Entry Types.md"
transfer-encoding: chunkedUpdate Minute Entry TypesPUT/research-common/api/v1/minute-entry-types/(key)
Example URI
PUT /research-common/api/v1/minute-entry-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Minute Entry TypesPUT/research-common/api/v1/minute-entry-types/
Example URI
PUT /research-common/api/v1/minute-entry-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Minute Entry TypesPATCH/research-common/api/v1/minute-entry-types/(key)
Example URI
PATCH /research-common/api/v1/minute-entry-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Minute Entry TypesPOST/research-common/api/v1/minute-entry-types/
Example URI
POST /research-common/api/v1/minute-entry-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Minute Entry TypesPOST/research-common/api/v1/minute-entry-types/
Example URI
POST /research-common/api/v1/minute-entry-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"minuteEntryTypeCode": "(val)",
"sortId": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Minute Entry Types by KeyDELETE/research-common/api/v1/minute-entry-types/(key)
Example URI
DELETE /research-common/api/v1/minute-entry-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Minute Entry TypesDELETE/research-common/api/v1/minute-entry-types/
Example URI
DELETE /research-common/api/v1/minute-entry-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Minute Entry Types with MatchingDELETE/research-common/api/v1/minute-entry-types/
Example URI
DELETE /research-common/api/v1/minute-entry-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- minuteEntryTypeCode
string(optional)Minute Entry Type Code. Maximum length is 3.
- sortId
string(optional)Sort Id. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Non Organizational Rolodexes ¶
Get Non Organizational Rolodexes by KeyGET/research-common/api/v1/non-organizational-rolodexes/(key)
Example URI
GET /research-common/api/v1/non-organizational-rolodexes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Get All Non Organizational RolodexesGET/research-common/api/v1/non-organizational-rolodexes/
Example URI
GET /research-common/api/v1/non-organizational-rolodexes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Get All Non Organizational Rolodexes with FilteringGET/research-common/api/v1/non-organizational-rolodexes/
Example URI
GET /research-common/api/v1/non-organizational-rolodexes/
URI Parameters
- rolodexId
string(optional)Rolodex Id. Maximum length is 6.
- addressLine1
string(optional)Address Line 1. Maximum length is 80.
- addressLine2
string(optional)Address Line 2. Maximum length is 80.
- addressLine3
string(optional)Address Line 3. Maximum length is 80.
- city
string(optional)City. Maximum length is 30.
- comments
string(optional)Comments. Maximum length is 300.
- countryCode
string(optional)Country Code. Maximum length is 3.
- county
string(optional)County. Maximum length is 30.
- createUser
string(optional)- deleteFlag
string(optional)Delete Flag. Maximum length is 1.
- emailAddress
string(optional)Email Address. Maximum length is 60.
- faxNumber
string(optional)Fax Number. Maximum length is 20.
- firstName
string(optional)First Name. Maximum length is 20.
- lastName
string(optional)Last Name. Maximum length is 20.
- middleName
string(optional)Middle Name. Maximum length is 20.
- organization
string(optional)Organization. Maximum length is 80.
- ownedByUnit
string(optional)Owned By Unit. Maximum length is 8.
- phoneNumber
string(optional)Phone Number. Maximum length is 20.
- postalCode
string(optional)Postal Code. Maximum length is 15.
- prefix
string(optional)Prefix. Maximum length is 10.
- sponsorAddressFlag
string(optional)Sponsor Address Flag. Maximum length is 1.
- sponsorCode
string(optional)Sponsor Code. Maximum length is 6.
- state
string(optional)State. Maximum length is 30.
- suffix
string(optional)Suffix. Maximum length is 10.
- title
string(optional)Title. Maximum length is 35.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Non Organizational RolodexesGET/research-common/api/v1/non-organizational-rolodexes/
Example URI
GET /research-common/api/v1/non-organizational-rolodexes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"rolodexId",
"addressLine1",
"addressLine2",
"addressLine3",
"city",
"comments",
"countryCode",
"county",
"createUser",
"deleteFlag",
"emailAddress",
"faxNumber",
"firstName",
"lastName",
"middleName",
"organization",
"ownedByUnit",
"phoneNumber",
"postalCode",
"prefix",
"sponsorAddressFlag",
"sponsorCode",
"state",
"suffix",
"title"
],
"primaryKey": "rolodexId"
}Get Blueprint API specification for Non Organizational RolodexesGET/research-common/api/v1/non-organizational-rolodexes/
Example URI
GET /research-common/api/v1/non-organizational-rolodexes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Non Organizational Rolodexes.md"
transfer-encoding: chunkedUpdate Non Organizational RolodexesPUT/research-common/api/v1/non-organizational-rolodexes/(key)
Example URI
PUT /research-common/api/v1/non-organizational-rolodexes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Non Organizational RolodexesPUT/research-common/api/v1/non-organizational-rolodexes/
Example URI
PUT /research-common/api/v1/non-organizational-rolodexes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Non Organizational RolodexesPATCH/research-common/api/v1/non-organizational-rolodexes/(key)
Example URI
PATCH /research-common/api/v1/non-organizational-rolodexes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Insert Non Organizational RolodexesPOST/research-common/api/v1/non-organizational-rolodexes/
Example URI
POST /research-common/api/v1/non-organizational-rolodexes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Non Organizational RolodexesPOST/research-common/api/v1/non-organizational-rolodexes/
Example URI
POST /research-common/api/v1/non-organizational-rolodexes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Delete Non Organizational Rolodexes by KeyDELETE/research-common/api/v1/non-organizational-rolodexes/(key)
Example URI
DELETE /research-common/api/v1/non-organizational-rolodexes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Non Organizational RolodexesDELETE/research-common/api/v1/non-organizational-rolodexes/
Example URI
DELETE /research-common/api/v1/non-organizational-rolodexes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Non Organizational Rolodexes with MatchingDELETE/research-common/api/v1/non-organizational-rolodexes/
Example URI
DELETE /research-common/api/v1/non-organizational-rolodexes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- rolodexId
string(optional)Rolodex Id. Maximum length is 6.
- addressLine1
string(optional)Address Line 1. Maximum length is 80.
- addressLine2
string(optional)Address Line 2. Maximum length is 80.
- addressLine3
string(optional)Address Line 3. Maximum length is 80.
- city
string(optional)City. Maximum length is 30.
- comments
string(optional)Comments. Maximum length is 300.
- countryCode
string(optional)Country Code. Maximum length is 3.
- county
string(optional)County. Maximum length is 30.
- createUser
string(optional)- deleteFlag
string(optional)Delete Flag. Maximum length is 1.
- emailAddress
string(optional)Email Address. Maximum length is 60.
- faxNumber
string(optional)Fax Number. Maximum length is 20.
- firstName
string(optional)First Name. Maximum length is 20.
- lastName
string(optional)Last Name. Maximum length is 20.
- middleName
string(optional)Middle Name. Maximum length is 20.
- organization
string(optional)Organization. Maximum length is 80.
- ownedByUnit
string(optional)Owned By Unit. Maximum length is 8.
- phoneNumber
string(optional)Phone Number. Maximum length is 20.
- postalCode
string(optional)Postal Code. Maximum length is 15.
- prefix
string(optional)Prefix. Maximum length is 10.
- sponsorAddressFlag
string(optional)Sponsor Address Flag. Maximum length is 1.
- sponsorCode
string(optional)Sponsor Code. Maximum length is 6.
- state
string(optional)State. Maximum length is 30.
- suffix
string(optional)Suffix. Maximum length is 10.
- title
string(optional)Title. Maximum length is 35.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Notice Of Opportunities ¶
Get Notice Of Opportunities by KeyGET/research-common/api/v1/notice-of-opportunities/(key)
Example URI
GET /research-common/api/v1/notice-of-opportunities/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Notice Of OpportunitiesGET/research-common/api/v1/notice-of-opportunities/
Example URI
GET /research-common/api/v1/notice-of-opportunities/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Notice Of Opportunities with FilteringGET/research-common/api/v1/notice-of-opportunities/
Example URI
GET /research-common/api/v1/notice-of-opportunities/
URI Parameters
- code
string(optional)Notice of Opportunity. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Notice Of OpportunitiesGET/research-common/api/v1/notice-of-opportunities/
Example URI
GET /research-common/api/v1/notice-of-opportunities/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Notice Of OpportunitiesGET/research-common/api/v1/notice-of-opportunities/
Example URI
GET /research-common/api/v1/notice-of-opportunities/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notice Of Opportunities.md"
transfer-encoding: chunkedUpdate Notice Of OpportunitiesPUT/research-common/api/v1/notice-of-opportunities/(key)
Example URI
PUT /research-common/api/v1/notice-of-opportunities/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Notice Of OpportunitiesPUT/research-common/api/v1/notice-of-opportunities/
Example URI
PUT /research-common/api/v1/notice-of-opportunities/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Notice Of OpportunitiesPATCH/research-common/api/v1/notice-of-opportunities/(key)
Example URI
PATCH /research-common/api/v1/notice-of-opportunities/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Notice Of OpportunitiesPOST/research-common/api/v1/notice-of-opportunities/
Example URI
POST /research-common/api/v1/notice-of-opportunities/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Notice Of OpportunitiesPOST/research-common/api/v1/notice-of-opportunities/
Example URI
POST /research-common/api/v1/notice-of-opportunities/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Notice Of Opportunities by KeyDELETE/research-common/api/v1/notice-of-opportunities/(key)
Example URI
DELETE /research-common/api/v1/notice-of-opportunities/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Notice Of OpportunitiesDELETE/research-common/api/v1/notice-of-opportunities/
Example URI
DELETE /research-common/api/v1/notice-of-opportunities/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Notice Of Opportunities with MatchingDELETE/research-common/api/v1/notice-of-opportunities/
Example URI
DELETE /research-common/api/v1/notice-of-opportunities/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Notice of Opportunity. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Notification Module Role Qualifiers ¶
Get Notification Module Role Qualifiers by KeyGET/research-common/api/v1/notification-module-role-qualifiers/(key)
Example URI
GET /research-common/api/v1/notification-module-role-qualifiers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}Get All Notification Module Role QualifiersGET/research-common/api/v1/notification-module-role-qualifiers/
Example URI
GET /research-common/api/v1/notification-module-role-qualifiers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
},
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}
]Get All Notification Module Role Qualifiers with FilteringGET/research-common/api/v1/notification-module-role-qualifiers/
Example URI
GET /research-common/api/v1/notification-module-role-qualifiers/
URI Parameters
- notificationModuleRoleQualifierId
string(optional)Notification Module Role Qualifier Id. Maximum length is 6.
- notificationModuleRoleId
string(optional)Notification Module Role Id. Maximum length is 6.
- qualifier
string(optional)Role Qualifier. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
},
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Notification Module Role QualifiersGET/research-common/api/v1/notification-module-role-qualifiers/
Example URI
GET /research-common/api/v1/notification-module-role-qualifiers/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"notificationModuleRoleQualifierId",
"notificationModuleRoleId",
"qualifier"
],
"primaryKey": "notificationModuleRoleQualifierId"
}Get Blueprint API specification for Notification Module Role QualifiersGET/research-common/api/v1/notification-module-role-qualifiers/
Example URI
GET /research-common/api/v1/notification-module-role-qualifiers/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notification Module Role Qualifiers.md"
transfer-encoding: chunkedUpdate Notification Module Role QualifiersPUT/research-common/api/v1/notification-module-role-qualifiers/(key)
Example URI
PUT /research-common/api/v1/notification-module-role-qualifiers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Notification Module Role QualifiersPUT/research-common/api/v1/notification-module-role-qualifiers/
Example URI
PUT /research-common/api/v1/notification-module-role-qualifiers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
},
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Notification Module Role QualifiersPATCH/research-common/api/v1/notification-module-role-qualifiers/(key)
Example URI
PATCH /research-common/api/v1/notification-module-role-qualifiers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}Insert Notification Module Role QualifiersPOST/research-common/api/v1/notification-module-role-qualifiers/
Example URI
POST /research-common/api/v1/notification-module-role-qualifiers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Notification Module Role QualifiersPOST/research-common/api/v1/notification-module-role-qualifiers/
Example URI
POST /research-common/api/v1/notification-module-role-qualifiers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
},
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
},
{
"notificationModuleRoleQualifierId": "(val)",
"notificationModuleRoleId": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}
]Delete Notification Module Role Qualifiers by KeyDELETE/research-common/api/v1/notification-module-role-qualifiers/(key)
Example URI
DELETE /research-common/api/v1/notification-module-role-qualifiers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Notification Module Role QualifiersDELETE/research-common/api/v1/notification-module-role-qualifiers/
Example URI
DELETE /research-common/api/v1/notification-module-role-qualifiers/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Notification Module Role Qualifiers with MatchingDELETE/research-common/api/v1/notification-module-role-qualifiers/
Example URI
DELETE /research-common/api/v1/notification-module-role-qualifiers/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- notificationModuleRoleQualifierId
string(optional)Notification Module Role Qualifier Id. Maximum length is 6.
- notificationModuleRoleId
string(optional)Notification Module Role Id. Maximum length is 6.
- qualifier
string(optional)Role Qualifier. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Notification Module Roles ¶
Get Notification Module Roles by KeyGET/research-common/api/v1/notification-module-roles/(key)
Example URI
GET /research-common/api/v1/notification-module-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
}Get All Notification Module RolesGET/research-common/api/v1/notification-module-roles/
Example URI
GET /research-common/api/v1/notification-module-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
},
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
}
]Get All Notification Module Roles with FilteringGET/research-common/api/v1/notification-module-roles/
Example URI
GET /research-common/api/v1/notification-module-roles/
URI Parameters
- notificationModuleRoleId
string(optional)Notification Module Role Id. Maximum length is 6.
- moduleCode
string(optional)Module Code. Maximum length is 3.
- roleName
string(optional)Role Name. Maximum length is 125.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
},
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Notification Module RolesGET/research-common/api/v1/notification-module-roles/
Example URI
GET /research-common/api/v1/notification-module-roles/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"notificationModuleRoleId",
"moduleCode",
"roleName"
],
"primaryKey": "notificationModuleRoleId"
}Get Blueprint API specification for Notification Module RolesGET/research-common/api/v1/notification-module-roles/
Example URI
GET /research-common/api/v1/notification-module-roles/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notification Module Roles.md"
transfer-encoding: chunkedUpdate Notification Module RolesPUT/research-common/api/v1/notification-module-roles/(key)
Example URI
PUT /research-common/api/v1/notification-module-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Notification Module RolesPUT/research-common/api/v1/notification-module-roles/
Example URI
PUT /research-common/api/v1/notification-module-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
},
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Notification Module RolesPATCH/research-common/api/v1/notification-module-roles/(key)
Example URI
PATCH /research-common/api/v1/notification-module-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
}Insert Notification Module RolesPOST/research-common/api/v1/notification-module-roles/
Example URI
POST /research-common/api/v1/notification-module-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Notification Module RolesPOST/research-common/api/v1/notification-module-roles/
Example URI
POST /research-common/api/v1/notification-module-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
},
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
},
{
"notificationModuleRoleId": "(val)",
"moduleCode": "(val)",
"roleName": "(val)",
"_primaryKey": "(val)"
}
]Delete Notification Module Roles by KeyDELETE/research-common/api/v1/notification-module-roles/(key)
Example URI
DELETE /research-common/api/v1/notification-module-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Notification Module RolesDELETE/research-common/api/v1/notification-module-roles/
Example URI
DELETE /research-common/api/v1/notification-module-roles/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Notification Module Roles with MatchingDELETE/research-common/api/v1/notification-module-roles/
Example URI
DELETE /research-common/api/v1/notification-module-roles/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- notificationModuleRoleId
string(optional)Notification Module Role Id. Maximum length is 6.
- moduleCode
string(optional)Module Code. Maximum length is 3.
- roleName
string(optional)Role Name. Maximum length is 125.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Notification Type Recipients ¶
Get Notification Type Recipients by KeyGET/research-common/api/v1/notification-type-recipients/(key)
Example URI
GET /research-common/api/v1/notification-type-recipients/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
}Get All Notification Type RecipientsGET/research-common/api/v1/notification-type-recipients/
Example URI
GET /research-common/api/v1/notification-type-recipients/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
}
]Get All Notification Type Recipients with FilteringGET/research-common/api/v1/notification-type-recipients/
Example URI
GET /research-common/api/v1/notification-type-recipients/
URI Parameters
- notificationTypeRecipientId
string(optional)Notification Recipient Id. Maximum length is 6.
- notificationTypeId
string(optional)Notification Id. Maximum length is 6.
- roleName
string(optional)Role. Maximum length is 125.
- roleSubQualifier
string(optional)Sub Role. Maximum length is 125.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Notification Type RecipientsGET/research-common/api/v1/notification-type-recipients/
Example URI
GET /research-common/api/v1/notification-type-recipients/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"notificationTypeRecipientId",
"notificationTypeId",
"roleName",
"roleSubQualifier"
],
"primaryKey": "notificationTypeRecipientId"
}Get Blueprint API specification for Notification Type RecipientsGET/research-common/api/v1/notification-type-recipients/
Example URI
GET /research-common/api/v1/notification-type-recipients/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notification Type Recipients.md"
transfer-encoding: chunkedUpdate Notification Type RecipientsPUT/research-common/api/v1/notification-type-recipients/(key)
Example URI
PUT /research-common/api/v1/notification-type-recipients/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Notification Type RecipientsPUT/research-common/api/v1/notification-type-recipients/
Example URI
PUT /research-common/api/v1/notification-type-recipients/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Notification Type RecipientsPATCH/research-common/api/v1/notification-type-recipients/(key)
Example URI
PATCH /research-common/api/v1/notification-type-recipients/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
}Insert Notification Type RecipientsPOST/research-common/api/v1/notification-type-recipients/
Example URI
POST /research-common/api/v1/notification-type-recipients/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Notification Type RecipientsPOST/research-common/api/v1/notification-type-recipients/
Example URI
POST /research-common/api/v1/notification-type-recipients/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTypeRecipientId": "(val)",
"notificationTypeId": "(val)",
"roleName": "(val)",
"roleSubQualifier": "(val)",
"_primaryKey": "(val)"
}
]Delete Notification Type Recipients by KeyDELETE/research-common/api/v1/notification-type-recipients/(key)
Example URI
DELETE /research-common/api/v1/notification-type-recipients/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Notification Type RecipientsDELETE/research-common/api/v1/notification-type-recipients/
Example URI
DELETE /research-common/api/v1/notification-type-recipients/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Notification Type Recipients with MatchingDELETE/research-common/api/v1/notification-type-recipients/
Example URI
DELETE /research-common/api/v1/notification-type-recipients/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- notificationTypeRecipientId
string(optional)Notification Recipient Id. Maximum length is 6.
- notificationTypeId
string(optional)Notification Id. Maximum length is 6.
- roleName
string(optional)Role. Maximum length is 125.
- roleSubQualifier
string(optional)Sub Role. Maximum length is 125.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Notification Types ¶
Get Notification Types by KeyGET/research-common/api/v1/notification-types/(key)
Example URI
GET /research-common/api/v1/notification-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Notification TypesGET/research-common/api/v1/notification-types/
Example URI
GET /research-common/api/v1/notification-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Notification Types with FilteringGET/research-common/api/v1/notification-types/
Example URI
GET /research-common/api/v1/notification-types/
URI Parameters
- notificationTypeId
string(optional)Notification Id. Maximum length is 6.
- moduleCode
string(optional)Module Code. Maximum length is 3.
- actionCode
string(optional)Action Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- subject
string(optional)Subject. Maximum length is 1000.
- message
string(optional)Message. Maximum length is 4000.
- promptUser
string(optional)Prompt User. Maximum length is 1.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Notification TypesGET/research-common/api/v1/notification-types/
Example URI
GET /research-common/api/v1/notification-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"notificationTypeId",
"moduleCode",
"actionCode",
"description",
"subject",
"message",
"promptUser",
"active"
],
"primaryKey": "notificationTypeId"
}Get Blueprint API specification for Notification TypesGET/research-common/api/v1/notification-types/
Example URI
GET /research-common/api/v1/notification-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notification Types.md"
transfer-encoding: chunkedUpdate Notification TypesPUT/research-common/api/v1/notification-types/(key)
Example URI
PUT /research-common/api/v1/notification-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Notification TypesPUT/research-common/api/v1/notification-types/
Example URI
PUT /research-common/api/v1/notification-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Notification TypesPATCH/research-common/api/v1/notification-types/(key)
Example URI
PATCH /research-common/api/v1/notification-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Notification TypesPOST/research-common/api/v1/notification-types/
Example URI
POST /research-common/api/v1/notification-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Notification TypesPOST/research-common/api/v1/notification-types/
Example URI
POST /research-common/api/v1/notification-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTypeId": "(val)",
"moduleCode": "(val)",
"actionCode": "(val)",
"description": "(val)",
"subject": "(val)",
"message": "(val)",
"promptUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Notification Types by KeyDELETE/research-common/api/v1/notification-types/(key)
Example URI
DELETE /research-common/api/v1/notification-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Notification TypesDELETE/research-common/api/v1/notification-types/
Example URI
DELETE /research-common/api/v1/notification-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Notification Types with MatchingDELETE/research-common/api/v1/notification-types/
Example URI
DELETE /research-common/api/v1/notification-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- notificationTypeId
string(optional)Notification Id. Maximum length is 6.
- moduleCode
string(optional)Module Code. Maximum length is 3.
- actionCode
string(optional)Action Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- subject
string(optional)Subject. Maximum length is 1000.
- message
string(optional)Message. Maximum length is 4000.
- promptUser
string(optional)Prompt User. Maximum length is 1.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Nsf Codes ¶
Get Nsf Codes by KeyGET/research-common/api/v1/nsf-codes/(key)
Example URI
GET /research-common/api/v1/nsf-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Nsf CodesGET/research-common/api/v1/nsf-codes/
Example URI
GET /research-common/api/v1/nsf-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Nsf Codes with FilteringGET/research-common/api/v1/nsf-codes/
Example URI
GET /research-common/api/v1/nsf-codes/
URI Parameters
- nsfSequenceNumber
string(optional)The assigned sequence number. Maximum length is 12.
- nsfCode
string(optional)NSF Science Code. Maximum length is 15.
- year
string(optional)Year. Maximum length is 4.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Nsf CodesGET/research-common/api/v1/nsf-codes/
Example URI
GET /research-common/api/v1/nsf-codes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"nsfSequenceNumber",
"nsfCode",
"year",
"description"
],
"primaryKey": "nsfSequenceNumber"
}Get Blueprint API specification for Nsf CodesGET/research-common/api/v1/nsf-codes/
Example URI
GET /research-common/api/v1/nsf-codes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Nsf Codes.md"
transfer-encoding: chunkedUpdate Nsf CodesPUT/research-common/api/v1/nsf-codes/(key)
Example URI
PUT /research-common/api/v1/nsf-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Nsf CodesPUT/research-common/api/v1/nsf-codes/
Example URI
PUT /research-common/api/v1/nsf-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Nsf CodesPATCH/research-common/api/v1/nsf-codes/(key)
Example URI
PATCH /research-common/api/v1/nsf-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Nsf CodesPOST/research-common/api/v1/nsf-codes/
Example URI
POST /research-common/api/v1/nsf-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Nsf CodesPOST/research-common/api/v1/nsf-codes/
Example URI
POST /research-common/api/v1/nsf-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"nsfSequenceNumber": "(val)",
"nsfCode": "(val)",
"year": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Nsf Codes by KeyDELETE/research-common/api/v1/nsf-codes/(key)
Example URI
DELETE /research-common/api/v1/nsf-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Nsf CodesDELETE/research-common/api/v1/nsf-codes/
Example URI
DELETE /research-common/api/v1/nsf-codes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Nsf Codes with MatchingDELETE/research-common/api/v1/nsf-codes/
Example URI
DELETE /research-common/api/v1/nsf-codes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- nsfSequenceNumber
string(optional)The assigned sequence number. Maximum length is 12.
- nsfCode
string(optional)NSF Science Code. Maximum length is 15.
- year
string(optional)Year. Maximum length is 4.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Organization Audits ¶
Get Organization Audits by KeyGET/research-common/api/v1/organization-audits/(key)
Example URI
GET /research-common/api/v1/organization-audits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
}Get All Organization AuditsGET/research-common/api/v1/organization-audits/
Example URI
GET /research-common/api/v1/organization-audits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
},
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
}
]Get All Organization Audits with FilteringGET/research-common/api/v1/organization-audits/
Example URI
GET /research-common/api/v1/organization-audits/
URI Parameters
- fiscalYear
string(optional)Fiscal Year. Maximum length is 4.
- organizationId
string(optional)Organization Id. Maximum length is 8.
- auditAcceptedCode
string(optional)Audit Accepted Type. Maximum length is 3.
- auditComment
string(optional)Audit Comment. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
},
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Organization AuditsGET/research-common/api/v1/organization-audits/
Example URI
GET /research-common/api/v1/organization-audits/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"fiscalYear",
"organizationId",
"auditAcceptedCode",
"auditComment"
],
"primaryKey": "fiscalYear:organizationId"
}Get Blueprint API specification for Organization AuditsGET/research-common/api/v1/organization-audits/
Example URI
GET /research-common/api/v1/organization-audits/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Organization Audits.md"
transfer-encoding: chunkedUpdate Organization AuditsPUT/research-common/api/v1/organization-audits/(key)
Example URI
PUT /research-common/api/v1/organization-audits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Organization AuditsPUT/research-common/api/v1/organization-audits/
Example URI
PUT /research-common/api/v1/organization-audits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
},
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Organization AuditsPATCH/research-common/api/v1/organization-audits/(key)
Example URI
PATCH /research-common/api/v1/organization-audits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
}Insert Organization AuditsPOST/research-common/api/v1/organization-audits/
Example URI
POST /research-common/api/v1/organization-audits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Organization AuditsPOST/research-common/api/v1/organization-audits/
Example URI
POST /research-common/api/v1/organization-audits/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
},
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
},
{
"fiscalYear": "(val)",
"organizationId": "(val)",
"auditAcceptedCode": "(val)",
"auditComment": "(val)",
"_primaryKey": "(val)"
}
]Delete Organization Audits by KeyDELETE/research-common/api/v1/organization-audits/(key)
Example URI
DELETE /research-common/api/v1/organization-audits/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization AuditsDELETE/research-common/api/v1/organization-audits/
Example URI
DELETE /research-common/api/v1/organization-audits/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization Audits with MatchingDELETE/research-common/api/v1/organization-audits/
Example URI
DELETE /research-common/api/v1/organization-audits/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- fiscalYear
string(optional)Fiscal Year. Maximum length is 4.
- organizationId
string(optional)Organization Id. Maximum length is 8.
- auditAcceptedCode
string(optional)Audit Accepted Type. Maximum length is 3.
- auditComment
string(optional)Audit Comment. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Organization Audit Accepted Types ¶
Get Organization Audit Accepted Types by KeyGET/research-common/api/v1/organization-audit-accepted-types/(key)
Example URI
GET /research-common/api/v1/organization-audit-accepted-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Organization Audit Accepted TypesGET/research-common/api/v1/organization-audit-accepted-types/
Example URI
GET /research-common/api/v1/organization-audit-accepted-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Organization Audit Accepted Types with FilteringGET/research-common/api/v1/organization-audit-accepted-types/
Example URI
GET /research-common/api/v1/organization-audit-accepted-types/
URI Parameters
- code
string(optional)Organization Audit Accepted Type Code. Maximum length is 3.
- active
string(optional)Is Active. Maximum length is 1.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Organization Audit Accepted TypesGET/research-common/api/v1/organization-audit-accepted-types/
Example URI
GET /research-common/api/v1/organization-audit-accepted-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"active",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Organization Audit Accepted TypesGET/research-common/api/v1/organization-audit-accepted-types/
Example URI
GET /research-common/api/v1/organization-audit-accepted-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Organization Audit Accepted Types.md"
transfer-encoding: chunkedUpdate Organization Audit Accepted TypesPUT/research-common/api/v1/organization-audit-accepted-types/(key)
Example URI
PUT /research-common/api/v1/organization-audit-accepted-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Organization Audit Accepted TypesPUT/research-common/api/v1/organization-audit-accepted-types/
Example URI
PUT /research-common/api/v1/organization-audit-accepted-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Organization Audit Accepted TypesPATCH/research-common/api/v1/organization-audit-accepted-types/(key)
Example URI
PATCH /research-common/api/v1/organization-audit-accepted-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Organization Audit Accepted TypesPOST/research-common/api/v1/organization-audit-accepted-types/
Example URI
POST /research-common/api/v1/organization-audit-accepted-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Organization Audit Accepted TypesPOST/research-common/api/v1/organization-audit-accepted-types/
Example URI
POST /research-common/api/v1/organization-audit-accepted-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"active": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Organization Audit Accepted Types by KeyDELETE/research-common/api/v1/organization-audit-accepted-types/(key)
Example URI
DELETE /research-common/api/v1/organization-audit-accepted-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization Audit Accepted TypesDELETE/research-common/api/v1/organization-audit-accepted-types/
Example URI
DELETE /research-common/api/v1/organization-audit-accepted-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization Audit Accepted Types with MatchingDELETE/research-common/api/v1/organization-audit-accepted-types/
Example URI
DELETE /research-common/api/v1/organization-audit-accepted-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Organization Audit Accepted Type Code. Maximum length is 3.
- active
string(optional)Is Active. Maximum length is 1.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Organization Correspondents ¶
Get Organization Correspondents by KeyGET/research-common/api/v1/organization-correspondents/(key)
Example URI
GET /research-common/api/v1/organization-correspondents/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Organization CorrespondentsGET/research-common/api/v1/organization-correspondents/
Example URI
GET /research-common/api/v1/organization-correspondents/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Organization Correspondents with FilteringGET/research-common/api/v1/organization-correspondents/
Example URI
GET /research-common/api/v1/organization-correspondents/
URI Parameters
- correspondentId
string(optional)- organizationId
string(optional)Organization Id. Maximum length is 8.
- correspondentTypeCode
string(optional)Correspondent Type Code. Maximum length is 22.
- personId
string(optional)This is a generic implementation of a ‘SystemId’ attribute. It should always be overriden on the label, shortLabel, summary, and description, as these are only generic placeholders. Maximum length is 40.
- nonEmployeeFlag
string(optional)Non Employee Flag. Maximum length is 1.
- description
string(optional)Description. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Organization CorrespondentsGET/research-common/api/v1/organization-correspondents/
Example URI
GET /research-common/api/v1/organization-correspondents/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"correspondentId",
"organizationId",
"correspondentTypeCode",
"personId",
"nonEmployeeFlag",
"description"
],
"primaryKey": "correspondentId"
}Get Blueprint API specification for Organization CorrespondentsGET/research-common/api/v1/organization-correspondents/
Example URI
GET /research-common/api/v1/organization-correspondents/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Organization Correspondents.md"
transfer-encoding: chunkedUpdate Organization CorrespondentsPUT/research-common/api/v1/organization-correspondents/(key)
Example URI
PUT /research-common/api/v1/organization-correspondents/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Organization CorrespondentsPUT/research-common/api/v1/organization-correspondents/
Example URI
PUT /research-common/api/v1/organization-correspondents/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Organization CorrespondentsPATCH/research-common/api/v1/organization-correspondents/(key)
Example URI
PATCH /research-common/api/v1/organization-correspondents/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Organization CorrespondentsPOST/research-common/api/v1/organization-correspondents/
Example URI
POST /research-common/api/v1/organization-correspondents/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Organization CorrespondentsPOST/research-common/api/v1/organization-correspondents/
Example URI
POST /research-common/api/v1/organization-correspondents/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentId": "(val)",
"organizationId": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Organization Correspondents by KeyDELETE/research-common/api/v1/organization-correspondents/(key)
Example URI
DELETE /research-common/api/v1/organization-correspondents/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization CorrespondentsDELETE/research-common/api/v1/organization-correspondents/
Example URI
DELETE /research-common/api/v1/organization-correspondents/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization Correspondents with MatchingDELETE/research-common/api/v1/organization-correspondents/
Example URI
DELETE /research-common/api/v1/organization-correspondents/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- correspondentId
string(optional)- organizationId
string(optional)Organization Id. Maximum length is 8.
- correspondentTypeCode
string(optional)Correspondent Type Code. Maximum length is 22.
- personId
string(optional)This is a generic implementation of a ‘SystemId’ attribute. It should always be overriden on the label, shortLabel, summary, and description, as these are only generic placeholders. Maximum length is 40.
- nonEmployeeFlag
string(optional)Non Employee Flag. Maximum length is 1.
- description
string(optional)Description. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Organization Indirect Costs ¶
Get Organization Indirect Costs by KeyGET/research-common/api/v1/organization-indirect-costs/(key)
Example URI
GET /research-common/api/v1/organization-indirect-costs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
}Get All Organization Indirect CostsGET/research-common/api/v1/organization-indirect-costs/
Example URI
GET /research-common/api/v1/organization-indirect-costs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
},
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
}
]Get All Organization Indirect Costs with FilteringGET/research-common/api/v1/organization-indirect-costs/
Example URI
GET /research-common/api/v1/organization-indirect-costs/
URI Parameters
- idcNumber
string(optional)Idc Number. Maximum length is 3.
- organizationId
string(optional)Organization Id. Maximum length is 8.
- applicableIndirectcostRate
string(optional)Applicable Indirectcost Rate. Maximum length is 8.
- endDate
string(optional)End Date. Maximum length is 21.
- idcComment
string(optional)Idc Comment. Maximum length is 300.
- idcRateTypeCode
string(optional)Idc Rate Type Code. Maximum length is 3.
- requestedDate
string(optional)Requested Date. Maximum length is 10.
- startDate
string(optional)Start Date. Maximum length is 10.
- federalApprovingAgency
string(optional)Federal Approving Agency. Maximum length is 3.
- federalApprovingAgencyName
string(optional)Federal Approving Agency Name. Maximum length is 255.
- restrictedRatePolicy
string(optional)Restricted Rate Policy. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
},
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Organization Indirect CostsGET/research-common/api/v1/organization-indirect-costs/
Example URI
GET /research-common/api/v1/organization-indirect-costs/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"idcNumber",
"organizationId",
"applicableIndirectcostRate",
"endDate",
"idcComment",
"idcRateTypeCode",
"requestedDate",
"startDate",
"federalApprovingAgency",
"federalApprovingAgencyName",
"restrictedRatePolicy"
],
"primaryKey": "idcNumber:organizationId"
}Get Blueprint API specification for Organization Indirect CostsGET/research-common/api/v1/organization-indirect-costs/
Example URI
GET /research-common/api/v1/organization-indirect-costs/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Organization Indirect Costs.md"
transfer-encoding: chunkedUpdate Organization Indirect CostsPUT/research-common/api/v1/organization-indirect-costs/(key)
Example URI
PUT /research-common/api/v1/organization-indirect-costs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Organization Indirect CostsPUT/research-common/api/v1/organization-indirect-costs/
Example URI
PUT /research-common/api/v1/organization-indirect-costs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
},
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Organization Indirect CostsPATCH/research-common/api/v1/organization-indirect-costs/(key)
Example URI
PATCH /research-common/api/v1/organization-indirect-costs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
}Insert Organization Indirect CostsPOST/research-common/api/v1/organization-indirect-costs/
Example URI
POST /research-common/api/v1/organization-indirect-costs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Organization Indirect CostsPOST/research-common/api/v1/organization-indirect-costs/
Example URI
POST /research-common/api/v1/organization-indirect-costs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
},
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
},
{
"idcNumber": "(val)",
"organizationId": "(val)",
"applicableIndirectcostRate": "(val)",
"endDate": "(val)",
"idcComment": "(val)",
"idcRateTypeCode": "(val)",
"requestedDate": "(val)",
"startDate": "(val)",
"federalApprovingAgency": "(val)",
"federalApprovingAgencyName": "(val)",
"restrictedRatePolicy": "(val)",
"_primaryKey": "(val)"
}
]Delete Organization Indirect Costs by KeyDELETE/research-common/api/v1/organization-indirect-costs/(key)
Example URI
DELETE /research-common/api/v1/organization-indirect-costs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization Indirect CostsDELETE/research-common/api/v1/organization-indirect-costs/
Example URI
DELETE /research-common/api/v1/organization-indirect-costs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization Indirect Costs with MatchingDELETE/research-common/api/v1/organization-indirect-costs/
Example URI
DELETE /research-common/api/v1/organization-indirect-costs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- idcNumber
string(optional)Idc Number. Maximum length is 3.
- organizationId
string(optional)Organization Id. Maximum length is 8.
- applicableIndirectcostRate
string(optional)Applicable Indirectcost Rate. Maximum length is 8.
- endDate
string(optional)End Date. Maximum length is 21.
- idcComment
string(optional)Idc Comment. Maximum length is 300.
- idcRateTypeCode
string(optional)Idc Rate Type Code. Maximum length is 3.
- requestedDate
string(optional)Requested Date. Maximum length is 10.
- startDate
string(optional)Start Date. Maximum length is 10.
- federalApprovingAgency
string(optional)Federal Approving Agency. Maximum length is 3.
- federalApprovingAgencyName
string(optional)Federal Approving Agency Name. Maximum length is 255.
- restrictedRatePolicy
string(optional)Restricted Rate Policy. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Organization Type Lists ¶
Get Organization Type Lists by KeyGET/research-common/api/v1/organization-type-lists/(key)
Example URI
GET /research-common/api/v1/organization-type-lists/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Organization Type ListsGET/research-common/api/v1/organization-type-lists/
Example URI
GET /research-common/api/v1/organization-type-lists/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Organization Type Lists with FilteringGET/research-common/api/v1/organization-type-lists/
Example URI
GET /research-common/api/v1/organization-type-lists/
URI Parameters
- code
string(optional)Organization Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Organization Type ListsGET/research-common/api/v1/organization-type-lists/
Example URI
GET /research-common/api/v1/organization-type-lists/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Organization Type ListsGET/research-common/api/v1/organization-type-lists/
Example URI
GET /research-common/api/v1/organization-type-lists/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Organization Type Lists.md"
transfer-encoding: chunkedUpdate Organization Type ListsPUT/research-common/api/v1/organization-type-lists/(key)
Example URI
PUT /research-common/api/v1/organization-type-lists/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Organization Type ListsPUT/research-common/api/v1/organization-type-lists/
Example URI
PUT /research-common/api/v1/organization-type-lists/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Organization Type ListsPATCH/research-common/api/v1/organization-type-lists/(key)
Example URI
PATCH /research-common/api/v1/organization-type-lists/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Organization Type ListsPOST/research-common/api/v1/organization-type-lists/
Example URI
POST /research-common/api/v1/organization-type-lists/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Organization Type ListsPOST/research-common/api/v1/organization-type-lists/
Example URI
POST /research-common/api/v1/organization-type-lists/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Organization Type Lists by KeyDELETE/research-common/api/v1/organization-type-lists/(key)
Example URI
DELETE /research-common/api/v1/organization-type-lists/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization Type ListsDELETE/research-common/api/v1/organization-type-lists/
Example URI
DELETE /research-common/api/v1/organization-type-lists/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization Type Lists with MatchingDELETE/research-common/api/v1/organization-type-lists/
Example URI
DELETE /research-common/api/v1/organization-type-lists/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Organization Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Organization Types ¶
Get Organization Types by KeyGET/research-common/api/v1/organization-types/(key)
Example URI
GET /research-common/api/v1/organization-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Organization TypesGET/research-common/api/v1/organization-types/
Example URI
GET /research-common/api/v1/organization-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Organization Types with FilteringGET/research-common/api/v1/organization-types/
Example URI
GET /research-common/api/v1/organization-types/
URI Parameters
- organizationId
string(optional)Organization Id. Maximum length is 8.
- organizationTypeCode
string(optional)Organization Type Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Organization TypesGET/research-common/api/v1/organization-types/
Example URI
GET /research-common/api/v1/organization-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"organizationId",
"organizationTypeCode"
],
"primaryKey": "organizationId:organizationTypeCode"
}Get Blueprint API specification for Organization TypesGET/research-common/api/v1/organization-types/
Example URI
GET /research-common/api/v1/organization-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Organization Types.md"
transfer-encoding: chunkedUpdate Organization TypesPUT/research-common/api/v1/organization-types/(key)
Example URI
PUT /research-common/api/v1/organization-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Organization TypesPUT/research-common/api/v1/organization-types/
Example URI
PUT /research-common/api/v1/organization-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Organization TypesPATCH/research-common/api/v1/organization-types/(key)
Example URI
PATCH /research-common/api/v1/organization-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Organization TypesPOST/research-common/api/v1/organization-types/
Example URI
POST /research-common/api/v1/organization-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Organization TypesPOST/research-common/api/v1/organization-types/
Example URI
POST /research-common/api/v1/organization-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"organizationTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Organization Types by KeyDELETE/research-common/api/v1/organization-types/(key)
Example URI
DELETE /research-common/api/v1/organization-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization TypesDELETE/research-common/api/v1/organization-types/
Example URI
DELETE /research-common/api/v1/organization-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization Types with MatchingDELETE/research-common/api/v1/organization-types/
Example URI
DELETE /research-common/api/v1/organization-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- organizationId
string(optional)Organization Id. Maximum length is 8.
- organizationTypeCode
string(optional)Organization Type Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Organization Ynqs ¶
Get Organization Ynqs by KeyGET/research-common/api/v1/organization-ynqs/(key)
Example URI
GET /research-common/api/v1/organization-ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
}Get All Organization YnqsGET/research-common/api/v1/organization-ynqs/
Example URI
GET /research-common/api/v1/organization-ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
}
]Get All Organization Ynqs with FilteringGET/research-common/api/v1/organization-ynqs/
Example URI
GET /research-common/api/v1/organization-ynqs/
URI Parameters
- organizationId
string(optional)Organization Id. Maximum length is 8.
- questionId
string(optional)Question Id. Maximum length is 4.
- answer
string(optional)Answer. Maximum length is 1.
- explanation
string(optional)Explanation. Maximum length is 400.
- reviewDate
string(optional)Review Date. Maximum length is 10.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Organization YnqsGET/research-common/api/v1/organization-ynqs/
Example URI
GET /research-common/api/v1/organization-ynqs/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"organizationId",
"questionId",
"answer",
"explanation",
"reviewDate"
],
"primaryKey": "organizationId:questionId"
}Get Blueprint API specification for Organization YnqsGET/research-common/api/v1/organization-ynqs/
Example URI
GET /research-common/api/v1/organization-ynqs/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Organization Ynqs.md"
transfer-encoding: chunkedUpdate Organization YnqsPUT/research-common/api/v1/organization-ynqs/(key)
Example URI
PUT /research-common/api/v1/organization-ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Organization YnqsPUT/research-common/api/v1/organization-ynqs/
Example URI
PUT /research-common/api/v1/organization-ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Organization YnqsPATCH/research-common/api/v1/organization-ynqs/(key)
Example URI
PATCH /research-common/api/v1/organization-ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
}Insert Organization YnqsPOST/research-common/api/v1/organization-ynqs/
Example URI
POST /research-common/api/v1/organization-ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Organization YnqsPOST/research-common/api/v1/organization-ynqs/
Example URI
POST /research-common/api/v1/organization-ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"questionId": "(val)",
"answer": "(val)",
"explanation": "(val)",
"reviewDate": "(val)",
"_primaryKey": "(val)"
}
]Delete Organization Ynqs by KeyDELETE/research-common/api/v1/organization-ynqs/(key)
Example URI
DELETE /research-common/api/v1/organization-ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization YnqsDELETE/research-common/api/v1/organization-ynqs/
Example URI
DELETE /research-common/api/v1/organization-ynqs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organization Ynqs with MatchingDELETE/research-common/api/v1/organization-ynqs/
Example URI
DELETE /research-common/api/v1/organization-ynqs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- organizationId
string(optional)Organization Id. Maximum length is 8.
- questionId
string(optional)Question Id. Maximum length is 4.
- answer
string(optional)Answer. Maximum length is 1.
- explanation
string(optional)Explanation. Maximum length is 400.
- reviewDate
string(optional)Review Date. Maximum length is 10.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Organizations ¶
Get Organizations by KeyGET/research-common/api/v1/organizations/(key)
Example URI
GET /research-common/api/v1/organizations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
}Get All OrganizationsGET/research-common/api/v1/organizations/
Example URI
GET /research-common/api/v1/organizations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Organizations with FilteringGET/research-common/api/v1/organizations/
Example URI
GET /research-common/api/v1/organizations/
URI Parameters
- organizationId
string(optional)Organization Id. Maximum length is 8.
- address
string(optional)Address. Maximum length is 60.
- agencySymbol
string(optional)Agency Symbol. Maximum length is 30.
- animalWelfareAssurance
string(optional)Animal Welfare Assurance. Maximum length is 20.
- cableAddress
string(optional)Cable Address. Maximum length is 20.
- cageNumber
string(optional)CAGE Number. Maximum length is 20.
- cognizantAuditor
string(optional)Cognizant Auditor. Maximum length is 6.
- lobbyingRegistrant
string(optional)Lobbying Registrant. Maximum length is 6.
- lobbyingIndividual
string(optional)Lobbying Individual. Maximum length is 6.
- comGovEntityCode
string(optional)Com Gov Entity Code. Maximum length is 30.
- congressionalDistrict
string(optional)This field represents the “applicant” congressional district. Maximum length is 50.
- contactAddressId
string(optional)Contact Address Id. Maximum length is 6.
- county
string(optional)County. Maximum length is 30.
- dodacNumber
string(optional)DODAC Number. Maximum length is 20.
- dunsNumber
string(optional)DUNS Number. Maximum length is 20.
- dunsPlusFourNumber
string(optional)DUNS Plus Four Number. Maximum length is 20.
- uei
string(optional)Unique Entity ID. Maximum length is 12.
- federalEmployerId
string(optional)Federal Employer Id. Maximum length is 15.
- humanSubAssurance
string(optional)Human Sub Assurance. Maximum length is 30.
- incorporatedDate
string(optional)Incorporated Date. Maximum length is 10.
- incorporatedIn
string(optional)Incorporated In. Maximum length is 50.
- indirectCostRateAgreement
string(optional)Indirect Cost Rate Agreement. Maximum length is 50.
- irsTaxExemption
string(optional)IRS Tax Exemption. Maximum length is 30.
- stateEmployeeClaim
string(optional)State Employee Claim. Maximum length is 30.
- stateTaxExemptNum
string(optional)State Tax Exempt Num. Maximum length is 30.
- nsfInstitutionalCode
string(optional)NSF Institutional Code. Maximum length is 30.
- numberOfEmployees
string(optional)Number Of Employees. Maximum length is 6.
- onrResidentRep
string(optional)ONR Resident Rep. Maximum length is 6.
- organizationName
string(optional)Organization Name. Maximum length is 200.
- phsAccount
string(optional)PHS Account. Maximum length is 30.
- scienceMisconductComplDate
string(optional)Science Misconduct Compl Date. Maximum length is 10.
- telexNumber
string(optional)Telex Number. Maximum length is 20.
- vendorCode
string(optional)Vendor Code. Maximum length is 30.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for OrganizationsGET/research-common/api/v1/organizations/
Example URI
GET /research-common/api/v1/organizations/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{"columns":["organizationId","address","agencySymbol","animalWelfareAssurance","cableAddress","cageNumber","cognizantAuditor","lobbyingRegistrant","lobbyingIndividual","comGovEntityCode","congressionalDistrict","contactAddressId","county","dodacNumber","dunsNumber","dunsPlusFourNumber","uei": "(val)","federalEmployerId","humanSubAssurance","incorporatedDate","incorporatedIn","indirectCostRateAgreement","irsTaxExemption","stateEmployeeClaim","stateTaxExemptNum","nsfInstitutionalCode","numberOfEmployees","onrResidentRep","organizationName","phsAccount","scienceMisconductComplDate","telexNumber","vendorCode"],"primaryKey":"organizationId"}Get Blueprint API specification for OrganizationsGET/research-common/api/v1/organizations/
Example URI
GET /research-common/api/v1/organizations/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Organizations.md"
transfer-encoding: chunkedUpdate OrganizationsPUT/research-common/api/v1/organizations/(key)
Example URI
PUT /research-common/api/v1/organizations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple OrganizationsPUT/research-common/api/v1/organizations/
Example URI
PUT /research-common/api/v1/organizations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes OrganizationsPATCH/research-common/api/v1/organizations/(key)
Example URI
PATCH /research-common/api/v1/organizations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
}Insert OrganizationsPOST/research-common/api/v1/organizations/
Example URI
POST /research-common/api/v1/organizations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple OrganizationsPOST/research-common/api/v1/organizations/
Example URI
POST /research-common/api/v1/organizations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
},
{
"organizationId": "(val)",
"address": "(val)",
"agencySymbol": "(val)",
"animalWelfareAssurance": "(val)",
"cableAddress": "(val)",
"cageNumber": "(val)",
"cognizantAuditor": "(val)",
"lobbyingRegistrant": "(val)",
"lobbyingIndividual": "(val)",
"comGovEntityCode": "(val)",
"congressionalDistrict": "(val)",
"contactAddressId": "(val)",
"county": "(val)",
"dodacNumber": "(val)",
"dunsNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"uei": "(val)",
"federalEmployerId": "(val)",
"humanSubAssurance": "(val)",
"incorporatedDate": "(val)",
"incorporatedIn": "(val)",
"indirectCostRateAgreement": "(val)",
"irsTaxExemption": "(val)",
"stateEmployeeClaim": "(val)",
"stateTaxExemptNum": "(val)",
"nsfInstitutionalCode": "(val)",
"numberOfEmployees": "(val)",
"onrResidentRep": "(val)",
"organizationName": "(val)",
"phsAccount": "(val)",
"scienceMisconductComplDate": "(val)",
"telexNumber": "(val)",
"vendorCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Organizations by KeyDELETE/research-common/api/v1/organizations/(key)
Example URI
DELETE /research-common/api/v1/organizations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All OrganizationsDELETE/research-common/api/v1/organizations/
Example URI
DELETE /research-common/api/v1/organizations/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Organizations with MatchingDELETE/research-common/api/v1/organizations/
Example URI
DELETE /research-common/api/v1/organizations/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- organizationId
string(optional)Organization Id. Maximum length is 8.
- address
string(optional)Address. Maximum length is 60.
- agencySymbol
string(optional)Agency Symbol. Maximum length is 30.
- animalWelfareAssurance
string(optional)Animal Welfare Assurance. Maximum length is 20.
- cableAddress
string(optional)Cable Address. Maximum length is 20.
- cageNumber
string(optional)CAGE Number. Maximum length is 20.
- cognizantAuditor
string(optional)Cognizant Auditor. Maximum length is 6.
- lobbyingRegistrant
string(optional)Lobbying Registrant. Maximum length is 6.
- lobbyingIndividual
string(optional)Lobbying Individual. Maximum length is 6.
- comGovEntityCode
string(optional)Com Gov Entity Code. Maximum length is 30.
- congressionalDistrict
string(optional)This field represents the “applicant” congressional district. Maximum length is 50.
- contactAddressId
string(optional)Contact Address Id. Maximum length is 6.
- county
string(optional)County. Maximum length is 30.
- dodacNumber
string(optional)DODAC Number. Maximum length is 20.
- dunsNumber
string(optional)DUNS Number. Maximum length is 20.
- dunsPlusFourNumber
string(optional)DUNS Plus Four Number. Maximum length is 20.
- uei
string(optional)Unique Entity ID. Maximum length is 12.
- federalEmployerId
string(optional)Federal Employer Id. Maximum length is 15.
- humanSubAssurance
string(optional)Human Sub Assurance. Maximum length is 30.
- incorporatedDate
string(optional)Incorporated Date. Maximum length is 10.
- incorporatedIn
string(optional)Incorporated In. Maximum length is 50.
- indirectCostRateAgreement
string(optional)Indirect Cost Rate Agreement. Maximum length is 50.
- irsTaxExemption
string(optional)IRS Tax Exemption. Maximum length is 30.
- stateEmployeeClaim
string(optional)State Employee Claim. Maximum length is 30.
- stateTaxExemptNum
string(optional)State Tax Exempt Num. Maximum length is 30.
- nsfInstitutionalCode
string(optional)NSF Institutional Code. Maximum length is 30.
- numberOfEmployees
string(optional)Number Of Employees. Maximum length is 6.
- onrResidentRep
string(optional)ONR Resident Rep. Maximum length is 6.
- organizationName
string(optional)Organization Name. Maximum length is 200.
- phsAccount
string(optional)PHS Account. Maximum length is 30.
- scienceMisconductComplDate
string(optional)Science Misconduct Compl Date. Maximum length is 10.
- telexNumber
string(optional)Telex Number. Maximum length is 20.
- vendorCode
string(optional)Vendor Code. Maximum length is 30.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Organizations ¶
Organization SummaryGET/research-common/api/v1/organizations/?summary
Summary of all Organizations in the system
Example URI
GET /research-common/api/v1/organizations/?summary
URI Parameters
- summary
boolean(required)Renders the organizations in a summary view instead of the full data from the organization. Currently the only option and required.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"count": 1,
"totalFound": 1,
"organizations": [
{
"organizationName": "University",
"address": "1375 N Scottsdale Rd, Suite 480, Scottsdale, AZ 85257-3454",
"organizationId": "000001",
"contact": {
"middleName": null,
"county": "Maricopa",
"emailAddress": "sean.warren@rsmart.com",
"active": true,
"city": "Scottsdale",
"suffix": null,
"postalCode": "85257-3454",
"lastName": "Warren",
"addressLine3": null,
"addressLine2": "Suite 480",
"state": "AZ",
"firstName": "Sean",
"sponsor": null,
"prefix": null,
"rolodexId": 100013,
"phoneNumber": "480-414-0450",
"countryCode": "USA",
"addressLine1": "1375 N Scottsdale Rd, Scottsdale, AZ 85257-3454",
"title": "OSP Approver",
"faxNumber": "602-391-2172"
}
}
]
}Person Appointments ¶
Get Person Appointments by KeyGET/research-common/api/v1/person-appointments/(key)
Example URI
GET /research-common/api/v1/person-appointments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
}Get All Person AppointmentsGET/research-common/api/v1/person-appointments/
Example URI
GET /research-common/api/v1/person-appointments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
},
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
}
]Get All Person Appointments with FilteringGET/research-common/api/v1/person-appointments/
Example URI
GET /research-common/api/v1/person-appointments/
URI Parameters
- appointmentId
string(optional)Person Appointment Primary Key. Maximum length is 40.
- personId
string(optional)KcPersonExtendedAttributes Id. Maximum length is 40.
- unitNumber
string(optional)Unit. Maximum length is 8.
- startDate
string(optional)Start Date. Maximum length is 10.
- endDate
string(optional)End Date. Maximum length is 10.
- typeCode
string(optional)Appointment Type. Maximum length is 3.
- jobTitle
string(optional)Job Title. Maximum length is 50.
- preferedJobTitle
string(optional)Prefered Job Title. Maximum length is 51.
- jobCode
string(optional)Job Code. Maximum length is 6.
- salary
string(optional)Salary. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
},
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Person AppointmentsGET/research-common/api/v1/person-appointments/
Example URI
GET /research-common/api/v1/person-appointments/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"appointmentId",
"personId",
"unitNumber",
"startDate",
"endDate",
"typeCode",
"jobTitle",
"preferedJobTitle",
"jobCode",
"salary"
],
"primaryKey": "appointmentId"
}Get Blueprint API specification for Person AppointmentsGET/research-common/api/v1/person-appointments/
Example URI
GET /research-common/api/v1/person-appointments/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Appointments.md"
transfer-encoding: chunkedUpdate Person AppointmentsPUT/research-common/api/v1/person-appointments/(key)
Example URI
PUT /research-common/api/v1/person-appointments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Person AppointmentsPUT/research-common/api/v1/person-appointments/
Example URI
PUT /research-common/api/v1/person-appointments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
},
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Person AppointmentsPATCH/research-common/api/v1/person-appointments/(key)
Example URI
PATCH /research-common/api/v1/person-appointments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
}Insert Person AppointmentsPOST/research-common/api/v1/person-appointments/
Example URI
POST /research-common/api/v1/person-appointments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Person AppointmentsPOST/research-common/api/v1/person-appointments/
Example URI
POST /research-common/api/v1/person-appointments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
},
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
},
{
"appointmentId": "(val)",
"personId": "(val)",
"unitNumber": "(val)",
"startDate": "(val)",
"endDate": "(val)",
"typeCode": "(val)",
"jobTitle": "(val)",
"preferedJobTitle": "(val)",
"jobCode": "(val)",
"salary": "(val)",
"_primaryKey": "(val)"
}
]Delete Person Appointments by KeyDELETE/research-common/api/v1/person-appointments/(key)
Example URI
DELETE /research-common/api/v1/person-appointments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person AppointmentsDELETE/research-common/api/v1/person-appointments/
Example URI
DELETE /research-common/api/v1/person-appointments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person Appointments with MatchingDELETE/research-common/api/v1/person-appointments/
Example URI
DELETE /research-common/api/v1/person-appointments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- appointmentId
string(optional)Person Appointment Primary Key. Maximum length is 40.
- personId
string(optional)KcPersonExtendedAttributes Id. Maximum length is 40.
- unitNumber
string(optional)Unit. Maximum length is 8.
- startDate
string(optional)Start Date. Maximum length is 10.
- endDate
string(optional)End Date. Maximum length is 10.
- typeCode
string(optional)Appointment Type. Maximum length is 3.
- jobTitle
string(optional)Job Title. Maximum length is 50.
- preferedJobTitle
string(optional)Prefered Job Title. Maximum length is 51.
- jobCode
string(optional)Job Code. Maximum length is 6.
- salary
string(optional)Salary. Maximum length is 15.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Person Biosketches ¶
Get Person Biosketches by KeyGET/research-common/api/v1/person-biosketches/(key)
Example URI
GET /research-common/api/v1/person-biosketches/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}Get All Person BiosketchesGET/research-common/api/v1/person-biosketches/
Example URI
GET /research-common/api/v1/person-biosketches/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
},
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}
]Get All Person Biosketches with FilteringGET/research-common/api/v1/person-biosketches/
Example URI
GET /research-common/api/v1/person-biosketches/
URI Parameters
- personBiosketchId
string(optional)Person Biosketch Id. Maximum length is 22.
- personId
string(optional)- description
string(optional)Description. Maximum length is 4000.
- fileName
string(optional)- contentType
string(optional)- attachmentContent
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
},
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Person BiosketchesGET/research-common/api/v1/person-biosketches/
Example URI
GET /research-common/api/v1/person-biosketches/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"personBiosketchId",
"personId",
"description",
"fileName",
"contentType",
"attachmentContent"
],
"primaryKey": "personBiosketchId"
}Get Blueprint API specification for Person BiosketchesGET/research-common/api/v1/person-biosketches/
Example URI
GET /research-common/api/v1/person-biosketches/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Biosketches.md"
transfer-encoding: chunkedUpdate Person BiosketchesPUT/research-common/api/v1/person-biosketches/(key)
Example URI
PUT /research-common/api/v1/person-biosketches/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Person BiosketchesPUT/research-common/api/v1/person-biosketches/
Example URI
PUT /research-common/api/v1/person-biosketches/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
},
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Person BiosketchesPATCH/research-common/api/v1/person-biosketches/(key)
Example URI
PATCH /research-common/api/v1/person-biosketches/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}Insert Person BiosketchesPOST/research-common/api/v1/person-biosketches/
Example URI
POST /research-common/api/v1/person-biosketches/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Person BiosketchesPOST/research-common/api/v1/person-biosketches/
Example URI
POST /research-common/api/v1/person-biosketches/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
},
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
},
{
"personBiosketchId": "(val)",
"personId": "(val)",
"description": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"attachmentContent": "(val)",
"_primaryKey": "(val)"
}
]Delete Person Biosketches by KeyDELETE/research-common/api/v1/person-biosketches/(key)
Example URI
DELETE /research-common/api/v1/person-biosketches/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person BiosketchesDELETE/research-common/api/v1/person-biosketches/
Example URI
DELETE /research-common/api/v1/person-biosketches/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person Biosketches with MatchingDELETE/research-common/api/v1/person-biosketches/
Example URI
DELETE /research-common/api/v1/person-biosketches/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- personBiosketchId
string(optional)Person Biosketch Id. Maximum length is 22.
- personId
string(optional)- description
string(optional)Description. Maximum length is 4000.
- fileName
string(optional)- contentType
string(optional)- attachmentContent
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Person Custom Data ¶
Get Person Custom Data by KeyGET/research-common/api/v1/person-custom-data/(key)
Example URI
GET /research-common/api/v1/person-custom-data/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personCustomDataId": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}Get All Person Custom DataGET/research-common/api/v1/person-custom-data/
Example URI
GET /research-common/api/v1/person-custom-data/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personCustomDataId": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"personCustomDataId": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Get All Person Custom Data with FilteringGET/research-common/api/v1/person-custom-data/
Example URI
GET /research-common/api/v1/person-custom-data/
URI Parameters
- personCustomDataId
string(optional)Person Custom Data Id. Maximum length is 22.
- customAttributeId
string(optional)Custom Attribute Id. Maximum length is 22.
- value
string(optional)Value. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personCustomDataId": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
},
{
"personCustomDataId": "(val)",
"customAttributeId": "(val)",
"value": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Person Custom DataGET/research-common/api/v1/person-custom-data/
Example URI
GET /research-common/api/v1/person-custom-data/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"personCustomDataId",
"customAttributeId",
"value"
],
"primaryKey": "personCustomDataId"
}Get Blueprint API specification for Person Custom DataGET/research-common/api/v1/person-custom-data/
Example URI
GET /research-common/api/v1/person-custom-data/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Custom Data.md"
transfer-encoding: chunkedPerson Degrees ¶
Get Person Degrees by KeyGET/research-common/api/v1/person-degrees/(key)
Example URI
GET /research-common/api/v1/person-degrees/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}Get All Person DegreesGET/research-common/api/v1/person-degrees/
Example URI
GET /research-common/api/v1/person-degrees/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
},
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}
]Get All Person Degrees with FilteringGET/research-common/api/v1/person-degrees/
Example URI
GET /research-common/api/v1/person-degrees/
URI Parameters
- degreeId
string(optional)- personId
string(optional)KcPersonExtendedAttributes Id. Maximum length is 40.
- degreeCode
string(optional)Degree Code. Maximum length is 6.
- degree
string(optional)Degree. Maximum length is 80.
- graduationYear
string(optional)Graduation Year. Maximum length is 4.
- fieldOfStudy
string(optional)Field of Study. Maximum length is 80.
- specialization
string(optional)Specialization. Maximum length is 80.
- school
string(optional)School. Maximum length is 50.
- schoolIdCode
string(optional)School Id Code. Maximum length is 3.
- schoolId
string(optional)School Id. Maximum length is 20.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
},
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Person DegreesGET/research-common/api/v1/person-degrees/
Example URI
GET /research-common/api/v1/person-degrees/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"degreeId",
"personId",
"degreeCode",
"degree",
"graduationYear",
"fieldOfStudy",
"specialization",
"school",
"schoolIdCode",
"schoolId"
],
"primaryKey": "degreeId"
}Get Blueprint API specification for Person DegreesGET/research-common/api/v1/person-degrees/
Example URI
GET /research-common/api/v1/person-degrees/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Degrees.md"
transfer-encoding: chunkedUpdate Person DegreesPUT/research-common/api/v1/person-degrees/(key)
Example URI
PUT /research-common/api/v1/person-degrees/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Person DegreesPUT/research-common/api/v1/person-degrees/
Example URI
PUT /research-common/api/v1/person-degrees/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
},
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Person DegreesPATCH/research-common/api/v1/person-degrees/(key)
Example URI
PATCH /research-common/api/v1/person-degrees/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}Insert Person DegreesPOST/research-common/api/v1/person-degrees/
Example URI
POST /research-common/api/v1/person-degrees/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Person DegreesPOST/research-common/api/v1/person-degrees/
Example URI
POST /research-common/api/v1/person-degrees/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
},
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
},
{
"degreeId": "(val)",
"personId": "(val)",
"degreeCode": "(val)",
"degree": "(val)",
"graduationYear": "(val)",
"fieldOfStudy": "(val)",
"specialization": "(val)",
"school": "(val)",
"schoolIdCode": "(val)",
"schoolId": "(val)",
"_primaryKey": "(val)"
}
]Delete Person Degrees by KeyDELETE/research-common/api/v1/person-degrees/(key)
Example URI
DELETE /research-common/api/v1/person-degrees/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person DegreesDELETE/research-common/api/v1/person-degrees/
Example URI
DELETE /research-common/api/v1/person-degrees/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person Degrees with MatchingDELETE/research-common/api/v1/person-degrees/
Example URI
DELETE /research-common/api/v1/person-degrees/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- degreeId
string(optional)- personId
string(optional)KcPersonExtendedAttributes Id. Maximum length is 40.
- degreeCode
string(optional)Degree Code. Maximum length is 6.
- degree
string(optional)Degree. Maximum length is 80.
- graduationYear
string(optional)Graduation Year. Maximum length is 4.
- fieldOfStudy
string(optional)Field of Study. Maximum length is 80.
- specialization
string(optional)Specialization. Maximum length is 80.
- school
string(optional)School. Maximum length is 50.
- schoolIdCode
string(optional)School Id Code. Maximum length is 3.
- schoolId
string(optional)School Id. Maximum length is 20.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Person Editable Fields ¶
Get Person Editable Fields by KeyGET/research-common/api/v1/person-editable-fields/(key)
Example URI
GET /research-common/api/v1/person-editable-fields/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Person Editable FieldsGET/research-common/api/v1/person-editable-fields/
Example URI
GET /research-common/api/v1/person-editable-fields/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Person Editable Fields with FilteringGET/research-common/api/v1/person-editable-fields/
Example URI
GET /research-common/api/v1/person-editable-fields/
URI Parameters
- personEditableFieldId
string(optional)Person Editable Field Id. Maximum length is 12.
- moduleCode
string(optional)Module Code. Maximum length is 3.
- fieldName
string(optional)Field Name. Maximum length is 255.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Person Editable FieldsGET/research-common/api/v1/person-editable-fields/
Example URI
GET /research-common/api/v1/person-editable-fields/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"personEditableFieldId",
"moduleCode",
"fieldName",
"active"
],
"primaryKey": "personEditableFieldId"
}Get Blueprint API specification for Person Editable FieldsGET/research-common/api/v1/person-editable-fields/
Example URI
GET /research-common/api/v1/person-editable-fields/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Editable Fields.md"
transfer-encoding: chunkedUpdate Person Editable FieldsPUT/research-common/api/v1/person-editable-fields/(key)
Example URI
PUT /research-common/api/v1/person-editable-fields/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Person Editable FieldsPUT/research-common/api/v1/person-editable-fields/
Example URI
PUT /research-common/api/v1/person-editable-fields/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Person Editable FieldsPATCH/research-common/api/v1/person-editable-fields/(key)
Example URI
PATCH /research-common/api/v1/person-editable-fields/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Person Editable FieldsPOST/research-common/api/v1/person-editable-fields/
Example URI
POST /research-common/api/v1/person-editable-fields/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Person Editable FieldsPOST/research-common/api/v1/person-editable-fields/
Example URI
POST /research-common/api/v1/person-editable-fields/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"personEditableFieldId": "(val)",
"moduleCode": "(val)",
"fieldName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Person Editable Fields by KeyDELETE/research-common/api/v1/person-editable-fields/(key)
Example URI
DELETE /research-common/api/v1/person-editable-fields/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person Editable FieldsDELETE/research-common/api/v1/person-editable-fields/
Example URI
DELETE /research-common/api/v1/person-editable-fields/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person Editable Fields with MatchingDELETE/research-common/api/v1/person-editable-fields/
Example URI
DELETE /research-common/api/v1/person-editable-fields/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- personEditableFieldId
string(optional)Person Editable Field Id. Maximum length is 12.
- moduleCode
string(optional)Module Code. Maximum length is 3.
- fieldName
string(optional)Field Name. Maximum length is 255.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Person Mass Changes ¶
Get Person Mass Changes by KeyGET/research-common/api/v1/person-mass-changes/(key)
Example URI
GET /research-common/api/v1/person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personMassChangeId": "(val)",
"replaceePersonId": "(val)",
"replaceeRolodexId": "(val)",
"replacerPersonId": "(val)",
"replacerRolodexId": "(val)",
"changeAllSequences": "(val)",
"personMassChangeDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Get All Person Mass ChangesGET/research-common/api/v1/person-mass-changes/
Example URI
GET /research-common/api/v1/person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personMassChangeId": "(val)",
"replaceePersonId": "(val)",
"replaceeRolodexId": "(val)",
"replacerPersonId": "(val)",
"replacerRolodexId": "(val)",
"changeAllSequences": "(val)",
"personMassChangeDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"personMassChangeId": "(val)",
"replaceePersonId": "(val)",
"replaceeRolodexId": "(val)",
"replacerPersonId": "(val)",
"replacerRolodexId": "(val)",
"changeAllSequences": "(val)",
"personMassChangeDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Person Mass Changes with FilteringGET/research-common/api/v1/person-mass-changes/
Example URI
GET /research-common/api/v1/person-mass-changes/
URI Parameters
- personMassChangeId
string(optional)Person Mass Change Id. Maximum length is 12.
- replaceePersonId
string(optional)Employee. Maximum length is 40.
- replaceeRolodexId
string(optional)Non-Employee. Maximum length is 40.
- replacerPersonId
string(optional)Employee. Maximum length is 40.
- replacerRolodexId
string(optional)Non-Employee. Maximum length is 40.
- changeAllSequences
string(optional)Change All Sequences. Maximum length is 1.
- personMassChangeDocument.documentNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personMassChangeId": "(val)",
"replaceePersonId": "(val)",
"replaceeRolodexId": "(val)",
"replacerPersonId": "(val)",
"replacerRolodexId": "(val)",
"changeAllSequences": "(val)",
"personMassChangeDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"personMassChangeId": "(val)",
"replaceePersonId": "(val)",
"replaceeRolodexId": "(val)",
"replacerPersonId": "(val)",
"replacerRolodexId": "(val)",
"changeAllSequences": "(val)",
"personMassChangeDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Person Mass ChangesGET/research-common/api/v1/person-mass-changes/
Example URI
GET /research-common/api/v1/person-mass-changes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"personMassChangeId",
"replaceePersonId",
"replaceeRolodexId",
"replacerPersonId",
"replacerRolodexId",
"changeAllSequences",
"personMassChangeDocument.documentNumber"
],
"primaryKey": "personMassChangeId"
}Get Blueprint API specification for Person Mass ChangesGET/research-common/api/v1/person-mass-changes/
Example URI
GET /research-common/api/v1/person-mass-changes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Mass Changes.md"
transfer-encoding: chunkedPerson Signature Modules ¶
Get Person Signature Modules by KeyGET/research-common/api/v1/person-signature-modules/(key)
Example URI
GET /research-common/api/v1/person-signature-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
}Get All Person Signature ModulesGET/research-common/api/v1/person-signature-modules/
Example URI
GET /research-common/api/v1/person-signature-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
},
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Person Signature Modules with FilteringGET/research-common/api/v1/person-signature-modules/
Example URI
GET /research-common/api/v1/person-signature-modules/
URI Parameters
- personSignatureModuleId
string(optional)Person Signature Module ID. Maximum length is 12.
- personSignatureId
string(optional)Person Signature Code. Maximum length is 12.
- defaultSignature
string(optional)Indicate if this is the default module signature. Maximum length is 1.
- signatureActive
string(optional)Indicate if this signature is active for the module. Maximum length is 1.
- moduleCode
string(optional)Module Code. Maximum length is 5.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
},
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Person Signature ModulesGET/research-common/api/v1/person-signature-modules/
Example URI
GET /research-common/api/v1/person-signature-modules/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"personSignatureModuleId",
"personSignatureId",
"defaultSignature",
"signatureActive",
"moduleCode"
],
"primaryKey": "personSignatureModuleId"
}Get Blueprint API specification for Person Signature ModulesGET/research-common/api/v1/person-signature-modules/
Example URI
GET /research-common/api/v1/person-signature-modules/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Signature Modules.md"
transfer-encoding: chunkedUpdate Person Signature ModulesPUT/research-common/api/v1/person-signature-modules/(key)
Example URI
PUT /research-common/api/v1/person-signature-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Person Signature ModulesPUT/research-common/api/v1/person-signature-modules/
Example URI
PUT /research-common/api/v1/person-signature-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
},
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Person Signature ModulesPATCH/research-common/api/v1/person-signature-modules/(key)
Example URI
PATCH /research-common/api/v1/person-signature-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
}Insert Person Signature ModulesPOST/research-common/api/v1/person-signature-modules/
Example URI
POST /research-common/api/v1/person-signature-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Person Signature ModulesPOST/research-common/api/v1/person-signature-modules/
Example URI
POST /research-common/api/v1/person-signature-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
},
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
},
{
"personSignatureModuleId": "(val)",
"personSignatureId": "(val)",
"defaultSignature": "(val)",
"signatureActive": "(val)",
"moduleCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Person Signature Modules by KeyDELETE/research-common/api/v1/person-signature-modules/(key)
Example URI
DELETE /research-common/api/v1/person-signature-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person Signature ModulesDELETE/research-common/api/v1/person-signature-modules/
Example URI
DELETE /research-common/api/v1/person-signature-modules/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person Signature Modules with MatchingDELETE/research-common/api/v1/person-signature-modules/
Example URI
DELETE /research-common/api/v1/person-signature-modules/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- personSignatureModuleId
string(optional)Person Signature Module ID. Maximum length is 12.
- personSignatureId
string(optional)Person Signature Code. Maximum length is 12.
- defaultSignature
string(optional)Indicate if this is the default module signature. Maximum length is 1.
- signatureActive
string(optional)Indicate if this signature is active for the module. Maximum length is 1.
- moduleCode
string(optional)Module Code. Maximum length is 5.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Person Signatures ¶
Get Person Signatures by KeyGET/research-common/api/v1/person-signatures/(key)
Example URI
GET /research-common/api/v1/person-signatures/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}Get All Person SignaturesGET/research-common/api/v1/person-signatures/
Example URI
GET /research-common/api/v1/person-signatures/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
},
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}
]Get All Person Signatures with FilteringGET/research-common/api/v1/person-signatures/
Example URI
GET /research-common/api/v1/person-signatures/
URI Parameters
- personSignatureId
string(optional)Person Signature Code. Maximum length is 12.
- personId
string(optional)KcPerson Id. Maximum length is 40.
- signatureActive
string(optional)Indicate if this signature is active. Maximum length is 1.
- attachmentContent
string(optional)- fileName
string(optional)- contentType
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
},
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Person SignaturesGET/research-common/api/v1/person-signatures/
Example URI
GET /research-common/api/v1/person-signatures/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"personSignatureId",
"personId",
"signatureActive",
"attachmentContent",
"fileName",
"contentType"
],
"primaryKey": "personSignatureId"
}Get Blueprint API specification for Person SignaturesGET/research-common/api/v1/person-signatures/
Example URI
GET /research-common/api/v1/person-signatures/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Signatures.md"
transfer-encoding: chunkedUpdate Person SignaturesPUT/research-common/api/v1/person-signatures/(key)
Example URI
PUT /research-common/api/v1/person-signatures/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Person SignaturesPUT/research-common/api/v1/person-signatures/
Example URI
PUT /research-common/api/v1/person-signatures/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
},
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Person SignaturesPATCH/research-common/api/v1/person-signatures/(key)
Example URI
PATCH /research-common/api/v1/person-signatures/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}Insert Person SignaturesPOST/research-common/api/v1/person-signatures/
Example URI
POST /research-common/api/v1/person-signatures/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Person SignaturesPOST/research-common/api/v1/person-signatures/
Example URI
POST /research-common/api/v1/person-signatures/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
},
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
},
{
"personSignatureId": "(val)",
"personId": "(val)",
"signatureActive": "(val)",
"attachmentContent": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}
]Delete Person Signatures by KeyDELETE/research-common/api/v1/person-signatures/(key)
Example URI
DELETE /research-common/api/v1/person-signatures/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person SignaturesDELETE/research-common/api/v1/person-signatures/
Example URI
DELETE /research-common/api/v1/person-signatures/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person Signatures with MatchingDELETE/research-common/api/v1/person-signatures/
Example URI
DELETE /research-common/api/v1/person-signatures/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- personSignatureId
string(optional)Person Signature Code. Maximum length is 12.
- personId
string(optional)KcPerson Id. Maximum length is 40.
- signatureActive
string(optional)Indicate if this signature is active. Maximum length is 1.
- attachmentContent
string(optional)- fileName
string(optional)- contentType
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Person Trainings ¶
Get Person Trainings by KeyGET/research-common/api/v1/person-trainings/(key)
Example URI
GET /research-common/api/v1/person-trainings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Person TrainingsGET/research-common/api/v1/person-trainings/
Example URI
GET /research-common/api/v1/person-trainings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Person Trainings with FilteringGET/research-common/api/v1/person-trainings/
Example URI
GET /research-common/api/v1/person-trainings/
URI Parameters
- personTrainingId
string(optional)Person Training Id. Maximum length is 22.
- personId
string(optional)Person Id. Maximum length is 40.
- trainingNumber
string(optional)Training Number. Maximum length is 4.
- trainingCode
string(optional)Training Code. Maximum length is 22.
- dateRequested
string(optional)Date Requested. Maximum length is 21.
- dateSubmitted
string(optional)Date Submitted. Maximum length is 21.
- dateAcknowledged
string(optional)Date Acknowledged. Maximum length is 21.
- followupDate
string(optional)Followup Date. Maximum length is 21.
- score
string(optional)Score. Maximum length is 9.
- comments
string(optional)Comments. Maximum length is 4000.
- active
string(optional)Is Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Person TrainingsGET/research-common/api/v1/person-trainings/
Example URI
GET /research-common/api/v1/person-trainings/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"personTrainingId",
"personId",
"trainingNumber",
"trainingCode",
"dateRequested",
"dateSubmitted",
"dateAcknowledged",
"followupDate",
"score",
"comments",
"active"
],
"primaryKey": "personTrainingId"
}Get Blueprint API specification for Person TrainingsGET/research-common/api/v1/person-trainings/
Example URI
GET /research-common/api/v1/person-trainings/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Trainings.md"
transfer-encoding: chunkedUpdate Person TrainingsPUT/research-common/api/v1/person-trainings/(key)
Example URI
PUT /research-common/api/v1/person-trainings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Person TrainingsPUT/research-common/api/v1/person-trainings/
Example URI
PUT /research-common/api/v1/person-trainings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Person TrainingsPATCH/research-common/api/v1/person-trainings/(key)
Example URI
PATCH /research-common/api/v1/person-trainings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Person TrainingsPOST/research-common/api/v1/person-trainings/
Example URI
POST /research-common/api/v1/person-trainings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Person TrainingsPOST/research-common/api/v1/person-trainings/
Example URI
POST /research-common/api/v1/person-trainings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"personTrainingId": "(val)",
"personId": "(val)",
"trainingNumber": "(val)",
"trainingCode": "(val)",
"dateRequested": "(val)",
"dateSubmitted": "(val)",
"dateAcknowledged": "(val)",
"followupDate": "(val)",
"score": "(val)",
"comments": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Person Trainings by KeyDELETE/research-common/api/v1/person-trainings/(key)
Example URI
DELETE /research-common/api/v1/person-trainings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person TrainingsDELETE/research-common/api/v1/person-trainings/
Example URI
DELETE /research-common/api/v1/person-trainings/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Person Trainings with MatchingDELETE/research-common/api/v1/person-trainings/
Example URI
DELETE /research-common/api/v1/person-trainings/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- personTrainingId
string(optional)Person Training Id. Maximum length is 22.
- personId
string(optional)Person Id. Maximum length is 40.
- trainingNumber
string(optional)Training Number. Maximum length is 4.
- trainingCode
string(optional)Training Code. Maximum length is 22.
- dateRequested
string(optional)Date Requested. Maximum length is 21.
- dateSubmitted
string(optional)Date Submitted. Maximum length is 21.
- dateAcknowledged
string(optional)Date Acknowledged. Maximum length is 21.
- followupDate
string(optional)Followup Date. Maximum length is 21.
- score
string(optional)Score. Maximum length is 9.
- comments
string(optional)Comments. Maximum length is 4000.
- active
string(optional)Is Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Prop Award Person Roles ¶
Get Prop Award Person Roles by KeyGET/research-common/api/v1/prop-award-person-roles/(key)
Example URI
GET /research-common/api/v1/prop-award-person-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
}Get All Prop Award Person RolesGET/research-common/api/v1/prop-award-person-roles/
Example URI
GET /research-common/api/v1/prop-award-person-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
}
]Get All Prop Award Person Roles with FilteringGET/research-common/api/v1/prop-award-person-roles/
Example URI
GET /research-common/api/v1/prop-award-person-roles/
URI Parameters
- id
string(optional)Proposal Person Role Id. Maximum length is 12.
- code
string(optional)Proposal Person Role Id. Maximum length is 12.
- sponsorHierarchyName
string(optional)Sponsor Hierarchy Name. Maximum length is 50.
- description
string(optional)Description. Maximum length is 25.
- certificationRequired
string(optional)Certification Required. Maximum length is 1.
- readOnly
string(optional)Read Only. Maximum length is 1.
- unitDetailsRequired
string(optional)Unit Details Required. Maximum length is 1.
- autoPopulateUnitsCode
string(optional)Unit Auto-Population. Maximum length is 20.
- selectedUnitSources
string(optional)Selected Units Source. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Prop Award Person RolesGET/research-common/api/v1/prop-award-person-roles/
Example URI
GET /research-common/api/v1/prop-award-person-roles/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"code",
"sponsorHierarchyName",
"description",
"certificationRequired",
"readOnly",
"unitDetailsRequired",
"autoPopulateUnitsCode",
"selectedUnitSources"
],
"primaryKey": "id"
}Get Blueprint API specification for Prop Award Person RolesGET/research-common/api/v1/prop-award-person-roles/
Example URI
GET /research-common/api/v1/prop-award-person-roles/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Prop Award Person Roles.md"
transfer-encoding: chunkedUpdate Prop Award Person RolesPUT/research-common/api/v1/prop-award-person-roles/(key)
Example URI
PUT /research-common/api/v1/prop-award-person-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Prop Award Person RolesPUT/research-common/api/v1/prop-award-person-roles/
Example URI
PUT /research-common/api/v1/prop-award-person-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Prop Award Person RolesPATCH/research-common/api/v1/prop-award-person-roles/(key)
Example URI
PATCH /research-common/api/v1/prop-award-person-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
}Insert Prop Award Person RolesPOST/research-common/api/v1/prop-award-person-roles/
Example URI
POST /research-common/api/v1/prop-award-person-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Prop Award Person RolesPOST/research-common/api/v1/prop-award-person-roles/
Example URI
POST /research-common/api/v1/prop-award-person-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"code": "(val)",
"sponsorHierarchyName": "(val)",
"description": "(val)",
"certificationRequired": "(val)",
"readOnly": "(val)",
"unitDetailsRequired": "(val)",
"autoPopulateUnitsCode": "(val)",
"selectedUnitSources": "(val)",
"_primaryKey": "(val)"
}
]Delete Prop Award Person Roles by KeyDELETE/research-common/api/v1/prop-award-person-roles/(key)
Example URI
DELETE /research-common/api/v1/prop-award-person-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Prop Award Person RolesDELETE/research-common/api/v1/prop-award-person-roles/
Example URI
DELETE /research-common/api/v1/prop-award-person-roles/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Prop Award Person Roles with MatchingDELETE/research-common/api/v1/prop-award-person-roles/
Example URI
DELETE /research-common/api/v1/prop-award-person-roles/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Proposal Person Role Id. Maximum length is 12.
- code
string(optional)Proposal Person Role Id. Maximum length is 12.
- sponsorHierarchyName
string(optional)Sponsor Hierarchy Name. Maximum length is 50.
- description
string(optional)Description. Maximum length is 25.
- certificationRequired
string(optional)Certification Required. Maximum length is 1.
- readOnly
string(optional)Read Only. Maximum length is 1.
- unitDetailsRequired
string(optional)Unit Details Required. Maximum length is 1.
- autoPopulateUnitsCode
string(optional)Unit Auto-Population. Maximum length is 20.
- selectedUnitSources
string(optional)Selected Units Source. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Proposal Types ¶
Get Proposal Types by KeyGET/research-common/api/v1/proposal-types/(key)
Example URI
GET /research-common/api/v1/proposal-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Proposal TypesGET/research-common/api/v1/proposal-types/
Example URI
GET /research-common/api/v1/proposal-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Proposal Types with FilteringGET/research-common/api/v1/proposal-types/
Example URI
GET /research-common/api/v1/proposal-types/
URI Parameters
- code
string(optional)Proposal Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Proposal TypesGET/research-common/api/v1/proposal-types/
Example URI
GET /research-common/api/v1/proposal-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Proposal TypesGET/research-common/api/v1/proposal-types/
Example URI
GET /research-common/api/v1/proposal-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposal Types.md"
transfer-encoding: chunkedUpdate Proposal TypesPUT/research-common/api/v1/proposal-types/(key)
Example URI
PUT /research-common/api/v1/proposal-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Proposal TypesPUT/research-common/api/v1/proposal-types/
Example URI
PUT /research-common/api/v1/proposal-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Proposal TypesPATCH/research-common/api/v1/proposal-types/(key)
Example URI
PATCH /research-common/api/v1/proposal-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Proposal TypesPOST/research-common/api/v1/proposal-types/
Example URI
POST /research-common/api/v1/proposal-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Proposal TypesPOST/research-common/api/v1/proposal-types/
Example URI
POST /research-common/api/v1/proposal-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Proposal Types by KeyDELETE/research-common/api/v1/proposal-types/(key)
Example URI
DELETE /research-common/api/v1/proposal-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal TypesDELETE/research-common/api/v1/proposal-types/
Example URI
DELETE /research-common/api/v1/proposal-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Proposal Types with MatchingDELETE/research-common/api/v1/proposal-types/
Example URI
DELETE /research-common/api/v1/proposal-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Proposal Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Recused Votes ¶
Get Protocol Recused Votes by KeyGET/research-common/api/v1/protocol-recused-votes/(key)
Example URI
GET /research-common/api/v1/protocol-recused-votes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Recused VotesGET/research-common/api/v1/protocol-recused-votes/
Example URI
GET /research-common/api/v1/protocol-recused-votes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Recused Votes with FilteringGET/research-common/api/v1/protocol-recused-votes/
Example URI
GET /research-common/api/v1/protocol-recused-votes/
URI Parameters
- protocolVoteRecusedId
string(optional)Protocol Vote Recused Id. Maximum length is 22.
- protocolIdFk
string(optional)Protocol Id. Maximum length is 22.
- submissionIdFk
string(optional)Schedule Id. Maximum length is 10.
- personId
string(optional)Person Id. Maximum length is 40.
- rolodexId
string(optional)- nonEmployeeFlag
string(optional)Non Employee Flag. Maximum length is 1.
- comments
string(optional)Comments. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Recused VotesGET/research-common/api/v1/protocol-recused-votes/
Example URI
GET /research-common/api/v1/protocol-recused-votes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolVoteRecusedId",
"protocolIdFk",
"submissionIdFk",
"personId",
"rolodexId",
"nonEmployeeFlag",
"comments"
],
"primaryKey": "protocolVoteRecusedId"
}Get Blueprint API specification for Protocol Recused VotesGET/research-common/api/v1/protocol-recused-votes/
Example URI
GET /research-common/api/v1/protocol-recused-votes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Recused Votes.md"
transfer-encoding: chunkedUpdate Protocol Recused VotesPUT/research-common/api/v1/protocol-recused-votes/(key)
Example URI
PUT /research-common/api/v1/protocol-recused-votes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Recused VotesPUT/research-common/api/v1/protocol-recused-votes/
Example URI
PUT /research-common/api/v1/protocol-recused-votes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Recused VotesPATCH/research-common/api/v1/protocol-recused-votes/(key)
Example URI
PATCH /research-common/api/v1/protocol-recused-votes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Recused VotesPOST/research-common/api/v1/protocol-recused-votes/
Example URI
POST /research-common/api/v1/protocol-recused-votes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Recused VotesPOST/research-common/api/v1/protocol-recused-votes/
Example URI
POST /research-common/api/v1/protocol-recused-votes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"protocolVoteRecusedId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Recused Votes by KeyDELETE/research-common/api/v1/protocol-recused-votes/(key)
Example URI
DELETE /research-common/api/v1/protocol-recused-votes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Recused VotesDELETE/research-common/api/v1/protocol-recused-votes/
Example URI
DELETE /research-common/api/v1/protocol-recused-votes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Recused Votes with MatchingDELETE/research-common/api/v1/protocol-recused-votes/
Example URI
DELETE /research-common/api/v1/protocol-recused-votes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolVoteRecusedId
string(optional)Protocol Vote Recused Id. Maximum length is 22.
- protocolIdFk
string(optional)Protocol Id. Maximum length is 22.
- submissionIdFk
string(optional)Schedule Id. Maximum length is 10.
- personId
string(optional)Person Id. Maximum length is 40.
- rolodexId
string(optional)- nonEmployeeFlag
string(optional)Non Employee Flag. Maximum length is 1.
- comments
string(optional)Comments. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Question Categories ¶
Get Question Categories by KeyGET/research-common/api/v1/question-categories/(key)
Example URI
GET /research-common/api/v1/question-categories/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Get All Question CategoriesGET/research-common/api/v1/question-categories/
Example URI
GET /research-common/api/v1/question-categories/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Get All Question Categories with FilteringGET/research-common/api/v1/question-categories/
Example URI
GET /research-common/api/v1/question-categories/
URI Parameters
- id
string(optional)Category Type Code. Maximum length is 3.
- name
string(optional)Category Name. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Question CategoriesGET/research-common/api/v1/question-categories/
Example URI
GET /research-common/api/v1/question-categories/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"name"
],
"primaryKey": "id"
}Get Blueprint API specification for Question CategoriesGET/research-common/api/v1/question-categories/
Example URI
GET /research-common/api/v1/question-categories/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Question Categories.md"
transfer-encoding: chunkedUpdate Question CategoriesPUT/research-common/api/v1/question-categories/(key)
Example URI
PUT /research-common/api/v1/question-categories/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Question CategoriesPUT/research-common/api/v1/question-categories/
Example URI
PUT /research-common/api/v1/question-categories/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Question CategoriesPATCH/research-common/api/v1/question-categories/(key)
Example URI
PATCH /research-common/api/v1/question-categories/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Insert Question CategoriesPOST/research-common/api/v1/question-categories/
Example URI
POST /research-common/api/v1/question-categories/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Question CategoriesPOST/research-common/api/v1/question-categories/
Example URI
POST /research-common/api/v1/question-categories/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Delete Question Categories by KeyDELETE/research-common/api/v1/question-categories/(key)
Example URI
DELETE /research-common/api/v1/question-categories/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Question CategoriesDELETE/research-common/api/v1/question-categories/
Example URI
DELETE /research-common/api/v1/question-categories/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Question Categories with MatchingDELETE/research-common/api/v1/question-categories/
Example URI
DELETE /research-common/api/v1/question-categories/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Category Type Code. Maximum length is 3.
- name
string(optional)Category Name. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Question Explanations ¶
Get Question Explanations by KeyGET/research-common/api/v1/question-explanations/(key)
Example URI
GET /research-common/api/v1/question-explanations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}Get All Question ExplanationsGET/research-common/api/v1/question-explanations/
Example URI
GET /research-common/api/v1/question-explanations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}
]Get All Question Explanations with FilteringGET/research-common/api/v1/question-explanations/
Example URI
GET /research-common/api/v1/question-explanations/
URI Parameters
- id
string(optional)Question Explanation Id. Maximum length is 12.
- questionId
string(optional)Question Ref Id. Maximum length is 12.
- explanationType
string(optional)Explanation Type. Maximum length is 1.
- explanation
string(optional)Explanation. Maximum length is 4000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Question ExplanationsGET/research-common/api/v1/question-explanations/
Example URI
GET /research-common/api/v1/question-explanations/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"questionId",
"explanationType",
"explanation"
],
"primaryKey": "id"
}Get Blueprint API specification for Question ExplanationsGET/research-common/api/v1/question-explanations/
Example URI
GET /research-common/api/v1/question-explanations/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Question Explanations.md"
transfer-encoding: chunkedUpdate Question ExplanationsPUT/research-common/api/v1/question-explanations/(key)
Example URI
PUT /research-common/api/v1/question-explanations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Question ExplanationsPUT/research-common/api/v1/question-explanations/
Example URI
PUT /research-common/api/v1/question-explanations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Question ExplanationsPATCH/research-common/api/v1/question-explanations/(key)
Example URI
PATCH /research-common/api/v1/question-explanations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}Insert Question ExplanationsPOST/research-common/api/v1/question-explanations/
Example URI
POST /research-common/api/v1/question-explanations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Question ExplanationsPOST/research-common/api/v1/question-explanations/
Example URI
POST /research-common/api/v1/question-explanations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionId": "(val)",
"explanationType": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}
]Delete Question Explanations by KeyDELETE/research-common/api/v1/question-explanations/(key)
Example URI
DELETE /research-common/api/v1/question-explanations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Question ExplanationsDELETE/research-common/api/v1/question-explanations/
Example URI
DELETE /research-common/api/v1/question-explanations/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Question Explanations with MatchingDELETE/research-common/api/v1/question-explanations/
Example URI
DELETE /research-common/api/v1/question-explanations/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Question Explanation Id. Maximum length is 12.
- questionId
string(optional)Question Ref Id. Maximum length is 12.
- explanationType
string(optional)Explanation Type. Maximum length is 1.
- explanation
string(optional)Explanation. Maximum length is 4000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Question Multi Choices ¶
Get Question Multi Choices by KeyGET/research-common/api/v1/question-multi-choices/(key)
Example URI
GET /research-common/api/v1/question-multi-choices/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Question Multi ChoicesGET/research-common/api/v1/question-multi-choices/
Example URI
GET /research-common/api/v1/question-multi-choices/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Question Multi Choices with FilteringGET/research-common/api/v1/question-multi-choices/
Example URI
GET /research-common/api/v1/question-multi-choices/
URI Parameters
- id
string(optional)Question Multi-Choice Id. Maximum length is 12.
- questionId
string(optional)Question Ref Id. Maximum length is 12.
- prompt
string(optional)Prompt. Maximum length is 200.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Question Multi ChoicesGET/research-common/api/v1/question-multi-choices/
Example URI
GET /research-common/api/v1/question-multi-choices/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"questionId",
"prompt",
"description"
],
"primaryKey": "id"
}Get Blueprint API specification for Question Multi ChoicesGET/research-common/api/v1/question-multi-choices/
Example URI
GET /research-common/api/v1/question-multi-choices/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Question Multi Choices.md"
transfer-encoding: chunkedUpdate Question Multi ChoicesPUT/research-common/api/v1/question-multi-choices/(key)
Example URI
PUT /research-common/api/v1/question-multi-choices/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Question Multi ChoicesPUT/research-common/api/v1/question-multi-choices/
Example URI
PUT /research-common/api/v1/question-multi-choices/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Question Multi ChoicesPATCH/research-common/api/v1/question-multi-choices/(key)
Example URI
PATCH /research-common/api/v1/question-multi-choices/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Question Multi ChoicesPOST/research-common/api/v1/question-multi-choices/
Example URI
POST /research-common/api/v1/question-multi-choices/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Question Multi ChoicesPOST/research-common/api/v1/question-multi-choices/
Example URI
POST /research-common/api/v1/question-multi-choices/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionId": "(val)",
"prompt": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Question Multi Choices by KeyDELETE/research-common/api/v1/question-multi-choices/(key)
Example URI
DELETE /research-common/api/v1/question-multi-choices/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Question Multi ChoicesDELETE/research-common/api/v1/question-multi-choices/
Example URI
DELETE /research-common/api/v1/question-multi-choices/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Question Multi Choices with MatchingDELETE/research-common/api/v1/question-multi-choices/
Example URI
DELETE /research-common/api/v1/question-multi-choices/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Question Multi-Choice Id. Maximum length is 12.
- questionId
string(optional)Question Ref Id. Maximum length is 12.
- prompt
string(optional)Prompt. Maximum length is 200.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Question Types ¶
Get Question Types by KeyGET/research-common/api/v1/question-types/(key)
Example URI
GET /research-common/api/v1/question-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Get All Question TypesGET/research-common/api/v1/question-types/
Example URI
GET /research-common/api/v1/question-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Get All Question Types with FilteringGET/research-common/api/v1/question-types/
Example URI
GET /research-common/api/v1/question-types/
URI Parameters
- id
string(optional)Question Type Id. Maximum length is 3.
- name
string(optional)Question Type Name. Maximum length is 30.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Question TypesGET/research-common/api/v1/question-types/
Example URI
GET /research-common/api/v1/question-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"name"
],
"primaryKey": "id"
}Get Blueprint API specification for Question TypesGET/research-common/api/v1/question-types/
Example URI
GET /research-common/api/v1/question-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Question Types.md"
transfer-encoding: chunkedUpdate Question TypesPUT/research-common/api/v1/question-types/(key)
Example URI
PUT /research-common/api/v1/question-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Question TypesPUT/research-common/api/v1/question-types/
Example URI
PUT /research-common/api/v1/question-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Question TypesPATCH/research-common/api/v1/question-types/(key)
Example URI
PATCH /research-common/api/v1/question-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Insert Question TypesPOST/research-common/api/v1/question-types/
Example URI
POST /research-common/api/v1/question-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Question TypesPOST/research-common/api/v1/question-types/
Example URI
POST /research-common/api/v1/question-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"name": "(val)",
"_primaryKey": "(val)"
}
]Delete Question Types by KeyDELETE/research-common/api/v1/question-types/(key)
Example URI
DELETE /research-common/api/v1/question-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Question TypesDELETE/research-common/api/v1/question-types/
Example URI
DELETE /research-common/api/v1/question-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Question Types with MatchingDELETE/research-common/api/v1/question-types/
Example URI
DELETE /research-common/api/v1/question-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Question Type Id. Maximum length is 3.
- name
string(optional)Question Type Name. Maximum length is 30.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Questionnaire Questions ¶
Get Questionnaire Questions by KeyGET/research-common/api/v1/questionnaire-questions/(key)
Example URI
GET /research-common/api/v1/questionnaire-questions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
}Get All Questionnaire QuestionsGET/research-common/api/v1/questionnaire-questions/
Example URI
GET /research-common/api/v1/questionnaire-questions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
}
]Get All Questionnaire Questions with FilteringGET/research-common/api/v1/questionnaire-questions/
Example URI
GET /research-common/api/v1/questionnaire-questions/
URI Parameters
- id
string(optional)Questionnaire Questions Id. Maximum length is 12.
- questionnaireId
string(optional)Questionnaire Id. Maximum length is 10.
- questionId
string(optional)Question Ref Id. Maximum length is 6.
- questionNumber
string(optional)Question Number. Maximum length is 6.
- parentQuestionNumber
string(optional)Parent Question Number. Maximum length is 6.
- conditionFlag
string(optional)Condition Flag. Maximum length is 1.
- condition
string(optional)Condition. Maximum length is 50.
- conditionValue
string(optional)Condition Value. Maximum length is 2000.
- questionSeqNumber
string(optional)Question Seq Number. Maximum length is 3.
- ruleId
string(optional)Question Seq Number. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Questionnaire QuestionsGET/research-common/api/v1/questionnaire-questions/
Example URI
GET /research-common/api/v1/questionnaire-questions/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"questionnaireId",
"questionId",
"questionNumber",
"parentQuestionNumber",
"conditionFlag",
"condition",
"conditionValue",
"questionSeqNumber",
"ruleId"
],
"primaryKey": "id"
}Get Blueprint API specification for Questionnaire QuestionsGET/research-common/api/v1/questionnaire-questions/
Example URI
GET /research-common/api/v1/questionnaire-questions/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Questionnaire Questions.md"
transfer-encoding: chunkedUpdate Questionnaire QuestionsPUT/research-common/api/v1/questionnaire-questions/(key)
Example URI
PUT /research-common/api/v1/questionnaire-questions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Questionnaire QuestionsPUT/research-common/api/v1/questionnaire-questions/
Example URI
PUT /research-common/api/v1/questionnaire-questions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Questionnaire QuestionsPATCH/research-common/api/v1/questionnaire-questions/(key)
Example URI
PATCH /research-common/api/v1/questionnaire-questions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
}Insert Questionnaire QuestionsPOST/research-common/api/v1/questionnaire-questions/
Example URI
POST /research-common/api/v1/questionnaire-questions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Questionnaire QuestionsPOST/research-common/api/v1/questionnaire-questions/
Example URI
POST /research-common/api/v1/questionnaire-questions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionnaireId": "(val)",
"questionId": "(val)",
"questionNumber": "(val)",
"parentQuestionNumber": "(val)",
"conditionFlag": "(val)",
"condition": "(val)",
"conditionValue": "(val)",
"questionSeqNumber": "(val)",
"ruleId": "(val)",
"_primaryKey": "(val)"
}
]Delete Questionnaire Questions by KeyDELETE/research-common/api/v1/questionnaire-questions/(key)
Example URI
DELETE /research-common/api/v1/questionnaire-questions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Questionnaire QuestionsDELETE/research-common/api/v1/questionnaire-questions/
Example URI
DELETE /research-common/api/v1/questionnaire-questions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Questionnaire Questions with MatchingDELETE/research-common/api/v1/questionnaire-questions/
Example URI
DELETE /research-common/api/v1/questionnaire-questions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Questionnaire Questions Id. Maximum length is 12.
- questionnaireId
string(optional)Questionnaire Id. Maximum length is 10.
- questionId
string(optional)Question Ref Id. Maximum length is 6.
- questionNumber
string(optional)Question Number. Maximum length is 6.
- parentQuestionNumber
string(optional)Parent Question Number. Maximum length is 6.
- conditionFlag
string(optional)Condition Flag. Maximum length is 1.
- condition
string(optional)Condition. Maximum length is 50.
- conditionValue
string(optional)Condition Value. Maximum length is 2000.
- questionSeqNumber
string(optional)Question Seq Number. Maximum length is 3.
- ruleId
string(optional)Question Seq Number. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Questionnaire Usages ¶
Get Questionnaire Usages by KeyGET/research-common/api/v1/questionnaire-usages/(key)
Example URI
GET /research-common/api/v1/questionnaire-usages/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}Get All Questionnaire UsagesGET/research-common/api/v1/questionnaire-usages/
Example URI
GET /research-common/api/v1/questionnaire-usages/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}
]Get All Questionnaire Usages with FilteringGET/research-common/api/v1/questionnaire-usages/
Example URI
GET /research-common/api/v1/questionnaire-usages/
URI Parameters
- id
string(optional)Questionnaire Usage Id. Maximum length is 12.
- moduleItemCode
string(optional)Module Item Code. Maximum length is 3.
- moduleSubItemCode
string(optional)Module Sub Item Code. Maximum length is 3.
- questionnaireSequenceNumber
string(optional)- questionnaireId
string(optional)Questionnaire Id. Maximum length is 6.
- ruleId
string(optional)Rule ID. Maximum length is 40.
- questionnaireLabel
string(optional)Questionnaire Label. Maximum length is 50.
- mandatory
string(optional)Is Mandatory. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Questionnaire UsagesGET/research-common/api/v1/questionnaire-usages/
Example URI
GET /research-common/api/v1/questionnaire-usages/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"moduleItemCode",
"moduleSubItemCode",
"questionnaireSequenceNumber",
"questionnaireId",
"ruleId",
"questionnaireLabel",
"mandatory"
],
"primaryKey": "id"
}Get Blueprint API specification for Questionnaire UsagesGET/research-common/api/v1/questionnaire-usages/
Example URI
GET /research-common/api/v1/questionnaire-usages/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Questionnaire Usages.md"
transfer-encoding: chunkedUpdate Questionnaire UsagesPUT/research-common/api/v1/questionnaire-usages/(key)
Example URI
PUT /research-common/api/v1/questionnaire-usages/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Questionnaire UsagesPUT/research-common/api/v1/questionnaire-usages/
Example URI
PUT /research-common/api/v1/questionnaire-usages/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Questionnaire UsagesPATCH/research-common/api/v1/questionnaire-usages/(key)
Example URI
PATCH /research-common/api/v1/questionnaire-usages/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}Insert Questionnaire UsagesPOST/research-common/api/v1/questionnaire-usages/
Example URI
POST /research-common/api/v1/questionnaire-usages/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Questionnaire UsagesPOST/research-common/api/v1/questionnaire-usages/
Example URI
POST /research-common/api/v1/questionnaire-usages/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"moduleItemCode": "(val)",
"moduleSubItemCode": "(val)",
"questionnaireSequenceNumber": "(val)",
"questionnaireId": "(val)",
"ruleId": "(val)",
"questionnaireLabel": "(val)",
"mandatory": "(val)",
"_primaryKey": "(val)"
}
]Delete Questionnaire Usages by KeyDELETE/research-common/api/v1/questionnaire-usages/(key)
Example URI
DELETE /research-common/api/v1/questionnaire-usages/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Questionnaire UsagesDELETE/research-common/api/v1/questionnaire-usages/
Example URI
DELETE /research-common/api/v1/questionnaire-usages/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Questionnaire Usages with MatchingDELETE/research-common/api/v1/questionnaire-usages/
Example URI
DELETE /research-common/api/v1/questionnaire-usages/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Questionnaire Usage Id. Maximum length is 12.
- moduleItemCode
string(optional)Module Item Code. Maximum length is 3.
- moduleSubItemCode
string(optional)Module Sub Item Code. Maximum length is 3.
- questionnaireSequenceNumber
string(optional)- questionnaireId
string(optional)Questionnaire Id. Maximum length is 6.
- ruleId
string(optional)Rule ID. Maximum length is 40.
- questionnaireLabel
string(optional)Questionnaire Label. Maximum length is 50.
- mandatory
string(optional)Is Mandatory. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Questionnaires ¶
Get Questionnaires by KeyGET/research-common/api/v1/questionnaires/(key)
Example URI
GET /research-common/api/v1/questionnaires/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
}Get All QuestionnairesGET/research-common/api/v1/questionnaires/
Example URI
GET /research-common/api/v1/questionnaires/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
}
]Get All Questionnaires with FilteringGET/research-common/api/v1/questionnaires/
Example URI
GET /research-common/api/v1/questionnaires/
URI Parameters
- id
string(optional)Questionnaire Ref Id. Maximum length is 10.
- questionnaireSeqId
string(optional)Questionnaire Id. Maximum length is 6.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- name
string(optional)Name. Maximum length is 50.
- description
string(optional)Description. Maximum length is 2000.
- active
string(optional)Is Active. Maximum length is 1.
- documentNumber
string(optional)Document Number. Maximum length is 10.
- fileName
string(optional)Template Name. Maximum length is 1000.
- template
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for QuestionnairesGET/research-common/api/v1/questionnaires/
Example URI
GET /research-common/api/v1/questionnaires/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"questionnaireSeqId",
"sequenceNumber",
"name",
"description",
"active",
"documentNumber",
"fileName",
"template"
],
"primaryKey": "id"
}Get Blueprint API specification for QuestionnairesGET/research-common/api/v1/questionnaires/
Example URI
GET /research-common/api/v1/questionnaires/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Questionnaires.md"
transfer-encoding: chunkedUpdate QuestionnairesPUT/research-common/api/v1/questionnaires/(key)
Example URI
PUT /research-common/api/v1/questionnaires/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple QuestionnairesPUT/research-common/api/v1/questionnaires/
Example URI
PUT /research-common/api/v1/questionnaires/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes QuestionnairesPATCH/research-common/api/v1/questionnaires/(key)
Example URI
PATCH /research-common/api/v1/questionnaires/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
}Insert QuestionnairesPOST/research-common/api/v1/questionnaires/
Example URI
POST /research-common/api/v1/questionnaires/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
}Insert Multiple QuestionnairesPOST/research-common/api/v1/questionnaires/
Example URI
POST /research-common/api/v1/questionnaires/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"questionnaireSeqId": "(val)",
"sequenceNumber": "(val)",
"name": "(val)",
"description": "(val)",
"active": "(val)",
"documentNumber": "(val)",
"fileName": "(val)",
"template": "(val)",
"_primaryKey": "(val)"
}
]Delete Questionnaires by KeyDELETE/research-common/api/v1/questionnaires/(key)
Example URI
DELETE /research-common/api/v1/questionnaires/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All QuestionnairesDELETE/research-common/api/v1/questionnaires/
Example URI
DELETE /research-common/api/v1/questionnaires/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Questionnaires with MatchingDELETE/research-common/api/v1/questionnaires/
Example URI
DELETE /research-common/api/v1/questionnaires/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Questionnaire Ref Id. Maximum length is 10.
- questionnaireSeqId
string(optional)Questionnaire Id. Maximum length is 6.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- name
string(optional)Name. Maximum length is 50.
- description
string(optional)Description. Maximum length is 2000.
- active
string(optional)Is Active. Maximum length is 1.
- documentNumber
string(optional)Document Number. Maximum length is 10.
- fileName
string(optional)Template Name. Maximum length is 1000.
- template
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Questions ¶
Get Questions by KeyGET/research-common/api/v1/questions/(key)
Example URI
GET /research-common/api/v1/questions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
}Get All QuestionsGET/research-common/api/v1/questions/
Example URI
GET /research-common/api/v1/questions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
}
]Get All Questions with FilteringGET/research-common/api/v1/questions/
Example URI
GET /research-common/api/v1/questions/
URI Parameters
- id
string(optional)Question Ref Id. Maximum length is 12.
- documentNumber
string(optional)Document Number. Maximum length is 10.
- questionSeqId
string(optional)Question Id. Maximum length is 6.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- sequenceStatus
string(optional)- question
string(optional)Question. Maximum length is 2000.
- status
string(optional)Status. Maximum length is 1.
- categoryTypeCode
string(optional)Category Type Code. Maximum length is 3.
- questionTypeId
string(optional)Question Type Id. Maximum length is 12.
- lookupClass
string(optional)Lookup Class. Maximum length is 100.
- lookupReturn
string(optional)Lookup Return. Maximum length is 30.
- displayedAnswers
string(optional)Displayed Answers. Maximum length is 2.
- maxAnswers
string(optional)Max Answers. Maximum length is 2.
- answerMaxLength
string(optional)Answer Max Length. Maximum length is 4.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for QuestionsGET/research-common/api/v1/questions/
Example URI
GET /research-common/api/v1/questions/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"documentNumber",
"questionSeqId",
"sequenceNumber",
"sequenceStatus",
"question",
"status",
"categoryTypeCode",
"questionTypeId",
"lookupClass",
"lookupReturn",
"displayedAnswers",
"maxAnswers",
"answerMaxLength"
],
"primaryKey": "id"
}Get Blueprint API specification for QuestionsGET/research-common/api/v1/questions/
Example URI
GET /research-common/api/v1/questions/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Questions.md"
transfer-encoding: chunkedUpdate QuestionsPUT/research-common/api/v1/questions/(key)
Example URI
PUT /research-common/api/v1/questions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple QuestionsPUT/research-common/api/v1/questions/
Example URI
PUT /research-common/api/v1/questions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes QuestionsPATCH/research-common/api/v1/questions/(key)
Example URI
PATCH /research-common/api/v1/questions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
}Insert QuestionsPOST/research-common/api/v1/questions/
Example URI
POST /research-common/api/v1/questions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
}Insert Multiple QuestionsPOST/research-common/api/v1/questions/
Example URI
POST /research-common/api/v1/questions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"documentNumber": "(val)",
"questionSeqId": "(val)",
"sequenceNumber": "(val)",
"sequenceStatus": "(val)",
"question": "(val)",
"status": "(val)",
"categoryTypeCode": "(val)",
"questionTypeId": "(val)",
"lookupClass": "(val)",
"lookupReturn": "(val)",
"displayedAnswers": "(val)",
"maxAnswers": "(val)",
"answerMaxLength": "(val)",
"_primaryKey": "(val)"
}
]Delete Questions by KeyDELETE/research-common/api/v1/questions/(key)
Example URI
DELETE /research-common/api/v1/questions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All QuestionsDELETE/research-common/api/v1/questions/
Example URI
DELETE /research-common/api/v1/questions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Questions with MatchingDELETE/research-common/api/v1/questions/
Example URI
DELETE /research-common/api/v1/questions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Question Ref Id. Maximum length is 12.
- documentNumber
string(optional)Document Number. Maximum length is 10.
- questionSeqId
string(optional)Question Id. Maximum length is 6.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- sequenceStatus
string(optional)- question
string(optional)Question. Maximum length is 2000.
- status
string(optional)Status. Maximum length is 1.
- categoryTypeCode
string(optional)Category Type Code. Maximum length is 3.
- questionTypeId
string(optional)Question Type Id. Maximum length is 12.
- lookupClass
string(optional)Lookup Class. Maximum length is 100.
- lookupReturn
string(optional)Lookup Return. Maximum length is 30.
- displayedAnswers
string(optional)Displayed Answers. Maximum length is 2.
- maxAnswers
string(optional)Max Answers. Maximum length is 2.
- answerMaxLength
string(optional)Answer Max Length. Maximum length is 4.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Rate Class Base Exclusions ¶
Get Rate Class Base Exclusions by KeyGET/research-common/api/v1/rate-class-base-exclusions/(key)
Example URI
GET /research-common/api/v1/rate-class-base-exclusions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
}Get All Rate Class Base ExclusionsGET/research-common/api/v1/rate-class-base-exclusions/
Example URI
GET /research-common/api/v1/rate-class-base-exclusions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
}
]Get All Rate Class Base Exclusions with FilteringGET/research-common/api/v1/rate-class-base-exclusions/
Example URI
GET /research-common/api/v1/rate-class-base-exclusions/
URI Parameters
- rateClassBaseExclusionId
string(optional)Rate Class Base Exclusion Id. Maximum length is 22.
- rateClassCode
string(optional)Rate Class. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type. Maximum length is 3.
- rateClassCodeExcl
string(optional)Rate Class Exclusion. Maximum length is 3.
- rateTypeCodeExcl
string(optional)Rate Type Exclusion. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Rate Class Base ExclusionsGET/research-common/api/v1/rate-class-base-exclusions/
Example URI
GET /research-common/api/v1/rate-class-base-exclusions/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"rateClassBaseExclusionId",
"rateClassCode",
"rateTypeCode",
"rateClassCodeExcl",
"rateTypeCodeExcl"
],
"primaryKey": "rateClassBaseExclusionId"
}Get Blueprint API specification for Rate Class Base ExclusionsGET/research-common/api/v1/rate-class-base-exclusions/
Example URI
GET /research-common/api/v1/rate-class-base-exclusions/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rate Class Base Exclusions.md"
transfer-encoding: chunkedUpdate Rate Class Base ExclusionsPUT/research-common/api/v1/rate-class-base-exclusions/(key)
Example URI
PUT /research-common/api/v1/rate-class-base-exclusions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Rate Class Base ExclusionsPUT/research-common/api/v1/rate-class-base-exclusions/
Example URI
PUT /research-common/api/v1/rate-class-base-exclusions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Rate Class Base ExclusionsPATCH/research-common/api/v1/rate-class-base-exclusions/(key)
Example URI
PATCH /research-common/api/v1/rate-class-base-exclusions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
}Insert Rate Class Base ExclusionsPOST/research-common/api/v1/rate-class-base-exclusions/
Example URI
POST /research-common/api/v1/rate-class-base-exclusions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Rate Class Base ExclusionsPOST/research-common/api/v1/rate-class-base-exclusions/
Example URI
POST /research-common/api/v1/rate-class-base-exclusions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassBaseExclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeExcl": "(val)",
"rateTypeCodeExcl": "(val)",
"_primaryKey": "(val)"
}
]Delete Rate Class Base Exclusions by KeyDELETE/research-common/api/v1/rate-class-base-exclusions/(key)
Example URI
DELETE /research-common/api/v1/rate-class-base-exclusions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Rate Class Base ExclusionsDELETE/research-common/api/v1/rate-class-base-exclusions/
Example URI
DELETE /research-common/api/v1/rate-class-base-exclusions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Rate Class Base Exclusions with MatchingDELETE/research-common/api/v1/rate-class-base-exclusions/
Example URI
DELETE /research-common/api/v1/rate-class-base-exclusions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- rateClassBaseExclusionId
string(optional)Rate Class Base Exclusion Id. Maximum length is 22.
- rateClassCode
string(optional)Rate Class. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type. Maximum length is 3.
- rateClassCodeExcl
string(optional)Rate Class Exclusion. Maximum length is 3.
- rateTypeCodeExcl
string(optional)Rate Type Exclusion. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Rate Class Base Inclusions ¶
Get Rate Class Base Inclusions by KeyGET/research-common/api/v1/rate-class-base-inclusions/(key)
Example URI
GET /research-common/api/v1/rate-class-base-inclusions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
}Get All Rate Class Base InclusionsGET/research-common/api/v1/rate-class-base-inclusions/
Example URI
GET /research-common/api/v1/rate-class-base-inclusions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
}
]Get All Rate Class Base Inclusions with FilteringGET/research-common/api/v1/rate-class-base-inclusions/
Example URI
GET /research-common/api/v1/rate-class-base-inclusions/
URI Parameters
- rateClassBaseInclusionId
string(optional)Rate Class Base Inclusion Id. Maximum length is 22.
- rateClassCode
string(optional)Rate Class. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type. Maximum length is 3.
- rateClassCodeIncl
string(optional)Rate Class Inclusion. Maximum length is 3.
- rateTypeCodeIncl
string(optional)Rate Type Inclusion. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Rate Class Base InclusionsGET/research-common/api/v1/rate-class-base-inclusions/
Example URI
GET /research-common/api/v1/rate-class-base-inclusions/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"rateClassBaseInclusionId",
"rateClassCode",
"rateTypeCode",
"rateClassCodeIncl",
"rateTypeCodeIncl"
],
"primaryKey": "rateClassBaseInclusionId"
}Get Blueprint API specification for Rate Class Base InclusionsGET/research-common/api/v1/rate-class-base-inclusions/
Example URI
GET /research-common/api/v1/rate-class-base-inclusions/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rate Class Base Inclusions.md"
transfer-encoding: chunkedUpdate Rate Class Base InclusionsPUT/research-common/api/v1/rate-class-base-inclusions/(key)
Example URI
PUT /research-common/api/v1/rate-class-base-inclusions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Rate Class Base InclusionsPUT/research-common/api/v1/rate-class-base-inclusions/
Example URI
PUT /research-common/api/v1/rate-class-base-inclusions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Rate Class Base InclusionsPATCH/research-common/api/v1/rate-class-base-inclusions/(key)
Example URI
PATCH /research-common/api/v1/rate-class-base-inclusions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
}Insert Rate Class Base InclusionsPOST/research-common/api/v1/rate-class-base-inclusions/
Example URI
POST /research-common/api/v1/rate-class-base-inclusions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Rate Class Base InclusionsPOST/research-common/api/v1/rate-class-base-inclusions/
Example URI
POST /research-common/api/v1/rate-class-base-inclusions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassBaseInclusionId": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"rateClassCodeIncl": "(val)",
"rateTypeCodeIncl": "(val)",
"_primaryKey": "(val)"
}
]Delete Rate Class Base Inclusions by KeyDELETE/research-common/api/v1/rate-class-base-inclusions/(key)
Example URI
DELETE /research-common/api/v1/rate-class-base-inclusions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Rate Class Base InclusionsDELETE/research-common/api/v1/rate-class-base-inclusions/
Example URI
DELETE /research-common/api/v1/rate-class-base-inclusions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Rate Class Base Inclusions with MatchingDELETE/research-common/api/v1/rate-class-base-inclusions/
Example URI
DELETE /research-common/api/v1/rate-class-base-inclusions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- rateClassBaseInclusionId
string(optional)Rate Class Base Inclusion Id. Maximum length is 22.
- rateClassCode
string(optional)Rate Class. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type. Maximum length is 3.
- rateClassCodeIncl
string(optional)Rate Class Inclusion. Maximum length is 3.
- rateTypeCodeIncl
string(optional)Rate Type Inclusion. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Rate Class Types ¶
Get Rate Class Types by KeyGET/research-common/api/v1/rate-class-types/(key)
Example URI
GET /research-common/api/v1/rate-class-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
}Get All Rate Class TypesGET/research-common/api/v1/rate-class-types/
Example URI
GET /research-common/api/v1/rate-class-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
}
]Get All Rate Class Types with FilteringGET/research-common/api/v1/rate-class-types/
Example URI
GET /research-common/api/v1/rate-class-types/
URI Parameters
- code
string(optional)Rate Class Type. Maximum length is 1.
- description
string(optional)Description. Maximum length is 200.
- sortId
string(optional)This sort id is used for sorting budget category. Maximum length is 2.
- prefixActivityType
string(optional)Prefix Activity Type in rates page. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Rate Class TypesGET/research-common/api/v1/rate-class-types/
Example URI
GET /research-common/api/v1/rate-class-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description",
"sortId",
"prefixActivityType"
],
"primaryKey": "code"
}Get Blueprint API specification for Rate Class TypesGET/research-common/api/v1/rate-class-types/
Example URI
GET /research-common/api/v1/rate-class-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rate Class Types.md"
transfer-encoding: chunkedUpdate Rate Class TypesPUT/research-common/api/v1/rate-class-types/(key)
Example URI
PUT /research-common/api/v1/rate-class-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Rate Class TypesPUT/research-common/api/v1/rate-class-types/
Example URI
PUT /research-common/api/v1/rate-class-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Rate Class TypesPATCH/research-common/api/v1/rate-class-types/(key)
Example URI
PATCH /research-common/api/v1/rate-class-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
}Insert Rate Class TypesPOST/research-common/api/v1/rate-class-types/
Example URI
POST /research-common/api/v1/rate-class-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Rate Class TypesPOST/research-common/api/v1/rate-class-types/
Example URI
POST /research-common/api/v1/rate-class-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"sortId": "(val)",
"prefixActivityType": "(val)",
"_primaryKey": "(val)"
}
]Delete Rate Class Types by KeyDELETE/research-common/api/v1/rate-class-types/(key)
Example URI
DELETE /research-common/api/v1/rate-class-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Rate Class TypesDELETE/research-common/api/v1/rate-class-types/
Example URI
DELETE /research-common/api/v1/rate-class-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Rate Class Types with MatchingDELETE/research-common/api/v1/rate-class-types/
Example URI
DELETE /research-common/api/v1/rate-class-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Rate Class Type. Maximum length is 1.
- description
string(optional)Description. Maximum length is 200.
- sortId
string(optional)This sort id is used for sorting budget category. Maximum length is 2.
- prefixActivityType
string(optional)Prefix Activity Type in rates page. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Rate Classes ¶
Get Rate Classes by KeyGET/research-common/api/v1/rate-classes/(key)
Example URI
GET /research-common/api/v1/rate-classes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Rate ClassesGET/research-common/api/v1/rate-classes/
Example URI
GET /research-common/api/v1/rate-classes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Rate Classes with FilteringGET/research-common/api/v1/rate-classes/
Example URI
GET /research-common/api/v1/rate-classes/
URI Parameters
- code
string(optional)Rate Class Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- rateClassTypeCode
string(optional)Rate Class Type. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Rate ClassesGET/research-common/api/v1/rate-classes/
Example URI
GET /research-common/api/v1/rate-classes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description",
"rateClassTypeCode"
],
"primaryKey": "code"
}Get Blueprint API specification for Rate ClassesGET/research-common/api/v1/rate-classes/
Example URI
GET /research-common/api/v1/rate-classes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rate Classes.md"
transfer-encoding: chunkedUpdate Rate ClassesPUT/research-common/api/v1/rate-classes/(key)
Example URI
PUT /research-common/api/v1/rate-classes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Rate ClassesPUT/research-common/api/v1/rate-classes/
Example URI
PUT /research-common/api/v1/rate-classes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Rate ClassesPATCH/research-common/api/v1/rate-classes/(key)
Example URI
PATCH /research-common/api/v1/rate-classes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Rate ClassesPOST/research-common/api/v1/rate-classes/
Example URI
POST /research-common/api/v1/rate-classes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Rate ClassesPOST/research-common/api/v1/rate-classes/
Example URI
POST /research-common/api/v1/rate-classes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"rateClassTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Rate Classes by KeyDELETE/research-common/api/v1/rate-classes/(key)
Example URI
DELETE /research-common/api/v1/rate-classes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Rate ClassesDELETE/research-common/api/v1/rate-classes/
Example URI
DELETE /research-common/api/v1/rate-classes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Rate Classes with MatchingDELETE/research-common/api/v1/rate-classes/
Example URI
DELETE /research-common/api/v1/rate-classes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Rate Class Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- rateClassTypeCode
string(optional)Rate Class Type. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Rate Types ¶
Get Rate Types by KeyGET/research-common/api/v1/rate-types/(key)
Example URI
GET /research-common/api/v1/rate-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Rate TypesGET/research-common/api/v1/rate-types/
Example URI
GET /research-common/api/v1/rate-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Rate Types with FilteringGET/research-common/api/v1/rate-types/
Example URI
GET /research-common/api/v1/rate-types/
URI Parameters
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Rate TypesGET/research-common/api/v1/rate-types/
Example URI
GET /research-common/api/v1/rate-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"rateClassCode",
"rateTypeCode",
"description"
],
"primaryKey": "rateClassCode:rateTypeCode"
}Get Blueprint API specification for Rate TypesGET/research-common/api/v1/rate-types/
Example URI
GET /research-common/api/v1/rate-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rate Types.md"
transfer-encoding: chunkedUpdate Rate TypesPUT/research-common/api/v1/rate-types/(key)
Example URI
PUT /research-common/api/v1/rate-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Rate TypesPUT/research-common/api/v1/rate-types/
Example URI
PUT /research-common/api/v1/rate-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Rate TypesPATCH/research-common/api/v1/rate-types/(key)
Example URI
PATCH /research-common/api/v1/rate-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Rate TypesPOST/research-common/api/v1/rate-types/
Example URI
POST /research-common/api/v1/rate-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Rate TypesPOST/research-common/api/v1/rate-types/
Example URI
POST /research-common/api/v1/rate-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Rate Types by KeyDELETE/research-common/api/v1/rate-types/(key)
Example URI
DELETE /research-common/api/v1/rate-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Rate TypesDELETE/research-common/api/v1/rate-types/
Example URI
DELETE /research-common/api/v1/rate-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Rate Types with MatchingDELETE/research-common/api/v1/rate-types/
Example URI
DELETE /research-common/api/v1/rate-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Research Users ¶
Get Current Research UserGET/research-common/api/v1/research-users/current/
Example URI
GET /research-common/api/v1/research-users/current/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personId": "(val)",
"userName": "(val)",
"primaryDepartmentCode": "(val)"
}Risk Levels ¶
Get Risk Levels by KeyGET/research-common/api/v1/risk-levels/(key)
Example URI
GET /research-common/api/v1/risk-levels/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Risk LevelsGET/research-common/api/v1/risk-levels/
Example URI
GET /research-common/api/v1/risk-levels/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Risk Levels with FilteringGET/research-common/api/v1/risk-levels/
Example URI
GET /research-common/api/v1/risk-levels/
URI Parameters
- riskLevelCode
string(optional)Risk Level Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Risk LevelsGET/research-common/api/v1/risk-levels/
Example URI
GET /research-common/api/v1/risk-levels/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"riskLevelCode",
"description"
],
"primaryKey": "riskLevelCode"
}Get Blueprint API specification for Risk LevelsGET/research-common/api/v1/risk-levels/
Example URI
GET /research-common/api/v1/risk-levels/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Risk Levels.md"
transfer-encoding: chunkedUpdate Risk LevelsPUT/research-common/api/v1/risk-levels/(key)
Example URI
PUT /research-common/api/v1/risk-levels/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Risk LevelsPUT/research-common/api/v1/risk-levels/
Example URI
PUT /research-common/api/v1/risk-levels/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Risk LevelsPATCH/research-common/api/v1/risk-levels/(key)
Example URI
PATCH /research-common/api/v1/risk-levels/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Risk LevelsPOST/research-common/api/v1/risk-levels/
Example URI
POST /research-common/api/v1/risk-levels/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Risk LevelsPOST/research-common/api/v1/risk-levels/
Example URI
POST /research-common/api/v1/risk-levels/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"riskLevelCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Risk Levels by KeyDELETE/research-common/api/v1/risk-levels/(key)
Example URI
DELETE /research-common/api/v1/risk-levels/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Risk LevelsDELETE/research-common/api/v1/risk-levels/
Example URI
DELETE /research-common/api/v1/risk-levels/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Risk Levels with MatchingDELETE/research-common/api/v1/risk-levels/
Example URI
DELETE /research-common/api/v1/risk-levels/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- riskLevelCode
string(optional)Risk Level Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Rolodexes ¶
Get Rolodexes by KeyGET/research-common/api/v1/rolodexes/(key)
Example URI
GET /research-common/api/v1/rolodexes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All RolodexesGET/research-common/api/v1/rolodexes/
Example URI
GET /research-common/api/v1/rolodexes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Rolodexes with FilteringGET/research-common/api/v1/rolodexes/
Example URI
GET /research-common/api/v1/rolodexes/
URI Parameters
- rolodexId
string(optional)Rolodex Id. Maximum length is 6.
- addressLine1
string(optional)Address Line 1. Maximum length is 80.
- addressLine2
string(optional)Address Line 2. Maximum length is 80.
- addressLine3
string(optional)Address Line 3. Maximum length is 80.
- city
string(optional)City. Maximum length is 30.
- comments
string(optional)Comments. Maximum length is 300.
- countryCode
string(optional)Country Code. Maximum length is 3.
- county
string(optional)County. Maximum length is 30.
- deleteFlag
string(optional)Delete Flag. Maximum length is 1.
- emailAddress
string(optional)Email Address. Maximum length is 60.
- faxNumber
string(optional)Fax Number. Maximum length is 20.
- firstName
string(optional)First Name. Maximum length is 20.
- lastName
string(optional)Last Name. Maximum length is 20.
- middleName
string(optional)Middle Name. Maximum length is 20.
- organization
string(optional)Organization. Maximum length is 200.
- ownedByUnit
string(optional)Owned By Unit. Maximum length is 8.
- phoneNumber
string(optional)Phone Number. Maximum length is 20.
- postalCode
string(optional)Postal Code. Maximum length is 15.
- prefix
string(optional)Prefix. Maximum length is 10.
- sponsorAddressFlag
string(optional)Sponsor Address Flag. Maximum length is 3.
- sponsorCode
string(optional)Sponsor Code. Maximum length is 6.
- state
string(optional)State. Maximum length is 30.
- suffix
string(optional)Suffix. Maximum length is 10.
- title
string(optional)Title. Maximum length is 35.
- createUser
string(optional)Create User.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for RolodexesGET/research-common/api/v1/rolodexes/
Example URI
GET /research-common/api/v1/rolodexes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"rolodexId",
"addressLine1",
"addressLine2",
"addressLine3",
"city",
"comments",
"countryCode",
"county",
"deleteFlag",
"emailAddress",
"faxNumber",
"firstName",
"lastName",
"middleName",
"organization",
"ownedByUnit",
"phoneNumber",
"postalCode",
"prefix",
"sponsorAddressFlag",
"sponsorCode",
"state",
"suffix",
"title",
"createUser",
"active"
],
"primaryKey": "rolodexId"
}Get Blueprint API specification for RolodexesGET/research-common/api/v1/rolodexes/
Example URI
GET /research-common/api/v1/rolodexes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rolodexes.md"
transfer-encoding: chunkedUpdate RolodexesPUT/research-common/api/v1/rolodexes/(key)
Example URI
PUT /research-common/api/v1/rolodexes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple RolodexesPUT/research-common/api/v1/rolodexes/
Example URI
PUT /research-common/api/v1/rolodexes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes RolodexesPATCH/research-common/api/v1/rolodexes/(key)
Example URI
PATCH /research-common/api/v1/rolodexes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert RolodexesPOST/research-common/api/v1/rolodexes/
Example URI
POST /research-common/api/v1/rolodexes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple RolodexesPOST/research-common/api/v1/rolodexes/
Example URI
POST /research-common/api/v1/rolodexes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"createUser": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Rolodexes by KeyDELETE/research-common/api/v1/rolodexes/(key)
Example URI
DELETE /research-common/api/v1/rolodexes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All RolodexesDELETE/research-common/api/v1/rolodexes/
Example URI
DELETE /research-common/api/v1/rolodexes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Rolodexes with MatchingDELETE/research-common/api/v1/rolodexes/
Example URI
DELETE /research-common/api/v1/rolodexes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- rolodexId
string(optional)Rolodex Id. Maximum length is 6.
- addressLine1
string(optional)Address Line 1. Maximum length is 80.
- addressLine2
string(optional)Address Line 2. Maximum length is 80.
- addressLine3
string(optional)Address Line 3. Maximum length is 80.
- city
string(optional)City. Maximum length is 30.
- comments
string(optional)Comments. Maximum length is 300.
- countryCode
string(optional)Country Code. Maximum length is 3.
- county
string(optional)County. Maximum length is 30.
- deleteFlag
string(optional)Delete Flag. Maximum length is 1.
- emailAddress
string(optional)Email Address. Maximum length is 60.
- faxNumber
string(optional)Fax Number. Maximum length is 20.
- firstName
string(optional)First Name. Maximum length is 20.
- lastName
string(optional)Last Name. Maximum length is 20.
- middleName
string(optional)Middle Name. Maximum length is 20.
- organization
string(optional)Organization. Maximum length is 200.
- ownedByUnit
string(optional)Owned By Unit. Maximum length is 8.
- phoneNumber
string(optional)Phone Number. Maximum length is 20.
- postalCode
string(optional)Postal Code. Maximum length is 15.
- prefix
string(optional)Prefix. Maximum length is 10.
- sponsorAddressFlag
string(optional)Sponsor Address Flag. Maximum length is 3.
- sponsorCode
string(optional)Sponsor Code. Maximum length is 6.
- state
string(optional)State. Maximum length is 30.
- suffix
string(optional)Suffix. Maximum length is 10.
- title
string(optional)Title. Maximum length is 35.
- createUser
string(optional)Create User.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Schedule Act Item Types ¶
Get Schedule Act Item Types by KeyGET/research-common/api/v1/schedule-act-item-types/(key)
Example URI
GET /research-common/api/v1/schedule-act-item-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Schedule Act Item TypesGET/research-common/api/v1/schedule-act-item-types/
Example URI
GET /research-common/api/v1/schedule-act-item-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Schedule Act Item Types with FilteringGET/research-common/api/v1/schedule-act-item-types/
Example URI
GET /research-common/api/v1/schedule-act-item-types/
URI Parameters
- scheduleActItemTypeCode
string(optional)Schedule Act Item Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Schedule Act Item TypesGET/research-common/api/v1/schedule-act-item-types/
Example URI
GET /research-common/api/v1/schedule-act-item-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"scheduleActItemTypeCode",
"description"
],
"primaryKey": "scheduleActItemTypeCode"
}Get Blueprint API specification for Schedule Act Item TypesGET/research-common/api/v1/schedule-act-item-types/
Example URI
GET /research-common/api/v1/schedule-act-item-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Schedule Act Item Types.md"
transfer-encoding: chunkedUpdate Schedule Act Item TypesPUT/research-common/api/v1/schedule-act-item-types/(key)
Example URI
PUT /research-common/api/v1/schedule-act-item-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Schedule Act Item TypesPUT/research-common/api/v1/schedule-act-item-types/
Example URI
PUT /research-common/api/v1/schedule-act-item-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Schedule Act Item TypesPATCH/research-common/api/v1/schedule-act-item-types/(key)
Example URI
PATCH /research-common/api/v1/schedule-act-item-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Schedule Act Item TypesPOST/research-common/api/v1/schedule-act-item-types/
Example URI
POST /research-common/api/v1/schedule-act-item-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Schedule Act Item TypesPOST/research-common/api/v1/schedule-act-item-types/
Example URI
POST /research-common/api/v1/schedule-act-item-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleActItemTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Schedule Act Item Types by KeyDELETE/research-common/api/v1/schedule-act-item-types/(key)
Example URI
DELETE /research-common/api/v1/schedule-act-item-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Schedule Act Item TypesDELETE/research-common/api/v1/schedule-act-item-types/
Example URI
DELETE /research-common/api/v1/schedule-act-item-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Schedule Act Item Types with MatchingDELETE/research-common/api/v1/schedule-act-item-types/
Example URI
DELETE /research-common/api/v1/schedule-act-item-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- scheduleActItemTypeCode
string(optional)Schedule Act Item Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Schedule Statuses ¶
Get Schedule Statuses by KeyGET/research-common/api/v1/schedule-statuses/(key)
Example URI
GET /research-common/api/v1/schedule-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Schedule StatusesGET/research-common/api/v1/schedule-statuses/
Example URI
GET /research-common/api/v1/schedule-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Schedule Statuses with FilteringGET/research-common/api/v1/schedule-statuses/
Example URI
GET /research-common/api/v1/schedule-statuses/
URI Parameters
- scheduleStatusCode
string(optional)Schedule Status Code. Maximum length is 22.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Schedule StatusesGET/research-common/api/v1/schedule-statuses/
Example URI
GET /research-common/api/v1/schedule-statuses/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"scheduleStatusCode",
"description"
],
"primaryKey": "scheduleStatusCode"
}Get Blueprint API specification for Schedule StatusesGET/research-common/api/v1/schedule-statuses/
Example URI
GET /research-common/api/v1/schedule-statuses/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Schedule Statuses.md"
transfer-encoding: chunkedUpdate Schedule StatusesPUT/research-common/api/v1/schedule-statuses/(key)
Example URI
PUT /research-common/api/v1/schedule-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Schedule StatusesPUT/research-common/api/v1/schedule-statuses/
Example URI
PUT /research-common/api/v1/schedule-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Schedule StatusesPATCH/research-common/api/v1/schedule-statuses/(key)
Example URI
PATCH /research-common/api/v1/schedule-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Schedule StatusesPOST/research-common/api/v1/schedule-statuses/
Example URI
POST /research-common/api/v1/schedule-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Schedule StatusesPOST/research-common/api/v1/schedule-statuses/
Example URI
POST /research-common/api/v1/schedule-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Schedule Statuses by KeyDELETE/research-common/api/v1/schedule-statuses/(key)
Example URI
DELETE /research-common/api/v1/schedule-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Schedule StatusesDELETE/research-common/api/v1/schedule-statuses/
Example URI
DELETE /research-common/api/v1/schedule-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Schedule Statuses with MatchingDELETE/research-common/api/v1/schedule-statuses/
Example URI
DELETE /research-common/api/v1/schedule-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- scheduleStatusCode
string(optional)Schedule Status Code. Maximum length is 22.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204School Codes ¶
Get School Codes by KeyGET/research-common/api/v1/school-codes/(key)
Example URI
GET /research-common/api/v1/school-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All School CodesGET/research-common/api/v1/school-codes/
Example URI
GET /research-common/api/v1/school-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All School Codes with FilteringGET/research-common/api/v1/school-codes/
Example URI
GET /research-common/api/v1/school-codes/
URI Parameters
- schoolCode
string(optional)School Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for School CodesGET/research-common/api/v1/school-codes/
Example URI
GET /research-common/api/v1/school-codes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"schoolCode",
"description"
],
"primaryKey": "schoolCode"
}Get Blueprint API specification for School CodesGET/research-common/api/v1/school-codes/
Example URI
GET /research-common/api/v1/school-codes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="School Codes.md"
transfer-encoding: chunkedUpdate School CodesPUT/research-common/api/v1/school-codes/(key)
Example URI
PUT /research-common/api/v1/school-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple School CodesPUT/research-common/api/v1/school-codes/
Example URI
PUT /research-common/api/v1/school-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes School CodesPATCH/research-common/api/v1/school-codes/(key)
Example URI
PATCH /research-common/api/v1/school-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert School CodesPOST/research-common/api/v1/school-codes/
Example URI
POST /research-common/api/v1/school-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple School CodesPOST/research-common/api/v1/school-codes/
Example URI
POST /research-common/api/v1/school-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"schoolCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete School Codes by KeyDELETE/research-common/api/v1/school-codes/(key)
Example URI
DELETE /research-common/api/v1/school-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All School CodesDELETE/research-common/api/v1/school-codes/
Example URI
DELETE /research-common/api/v1/school-codes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All School Codes with MatchingDELETE/research-common/api/v1/school-codes/
Example URI
DELETE /research-common/api/v1/school-codes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- schoolCode
string(optional)School Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Science Keywords ¶
Get Science Keywords by KeyGET/research-common/api/v1/science-keywords/(key)
Example URI
GET /research-common/api/v1/science-keywords/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Science KeywordsGET/research-common/api/v1/science-keywords/
Example URI
GET /research-common/api/v1/science-keywords/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Science Keywords with FilteringGET/research-common/api/v1/science-keywords/
Example URI
GET /research-common/api/v1/science-keywords/
URI Parameters
- code
string(optional)Science Keyword Code. Maximum length is 15.
- description
string(optional)The actual keyword(s) specific to the proposal that can be used in database lookups and reports. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Science KeywordsGET/research-common/api/v1/science-keywords/
Example URI
GET /research-common/api/v1/science-keywords/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Science KeywordsGET/research-common/api/v1/science-keywords/
Example URI
GET /research-common/api/v1/science-keywords/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Science Keywords.md"
transfer-encoding: chunkedUpdate Science KeywordsPUT/research-common/api/v1/science-keywords/(key)
Example URI
PUT /research-common/api/v1/science-keywords/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Science KeywordsPUT/research-common/api/v1/science-keywords/
Example URI
PUT /research-common/api/v1/science-keywords/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Science KeywordsPATCH/research-common/api/v1/science-keywords/(key)
Example URI
PATCH /research-common/api/v1/science-keywords/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Science KeywordsPOST/research-common/api/v1/science-keywords/
Example URI
POST /research-common/api/v1/science-keywords/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Science KeywordsPOST/research-common/api/v1/science-keywords/
Example URI
POST /research-common/api/v1/science-keywords/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Science Keywords by KeyDELETE/research-common/api/v1/science-keywords/(key)
Example URI
DELETE /research-common/api/v1/science-keywords/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Science KeywordsDELETE/research-common/api/v1/science-keywords/
Example URI
DELETE /research-common/api/v1/science-keywords/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Science Keywords with MatchingDELETE/research-common/api/v1/science-keywords/
Example URI
DELETE /research-common/api/v1/science-keywords/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Science Keyword Code. Maximum length is 15.
- description
string(optional)The actual keyword(s) specific to the proposal that can be used in database lookups and reports. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Special Review Approval Types ¶
Get Special Review Approval Types by KeyGET/research-common/api/v1/special-review-approval-types/(key)
Example URI
GET /research-common/api/v1/special-review-approval-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Special Review Approval TypesGET/research-common/api/v1/special-review-approval-types/
Example URI
GET /research-common/api/v1/special-review-approval-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Special Review Approval Types with FilteringGET/research-common/api/v1/special-review-approval-types/
Example URI
GET /research-common/api/v1/special-review-approval-types/
URI Parameters
- approvalTypeCode
string(optional)Special Review Approval Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Special Review Approval TypesGET/research-common/api/v1/special-review-approval-types/
Example URI
GET /research-common/api/v1/special-review-approval-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"approvalTypeCode",
"description"
],
"primaryKey": "approvalTypeCode"
}Get Blueprint API specification for Special Review Approval TypesGET/research-common/api/v1/special-review-approval-types/
Example URI
GET /research-common/api/v1/special-review-approval-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Special Review Approval Types.md"
transfer-encoding: chunkedUpdate Special Review Approval TypesPUT/research-common/api/v1/special-review-approval-types/(key)
Example URI
PUT /research-common/api/v1/special-review-approval-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Special Review Approval TypesPUT/research-common/api/v1/special-review-approval-types/
Example URI
PUT /research-common/api/v1/special-review-approval-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Special Review Approval TypesPATCH/research-common/api/v1/special-review-approval-types/(key)
Example URI
PATCH /research-common/api/v1/special-review-approval-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Special Review Approval TypesPOST/research-common/api/v1/special-review-approval-types/
Example URI
POST /research-common/api/v1/special-review-approval-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Special Review Approval TypesPOST/research-common/api/v1/special-review-approval-types/
Example URI
POST /research-common/api/v1/special-review-approval-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"approvalTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Special Review Approval Types by KeyDELETE/research-common/api/v1/special-review-approval-types/(key)
Example URI
DELETE /research-common/api/v1/special-review-approval-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Special Review Approval TypesDELETE/research-common/api/v1/special-review-approval-types/
Example URI
DELETE /research-common/api/v1/special-review-approval-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Special Review Approval Types with MatchingDELETE/research-common/api/v1/special-review-approval-types/
Example URI
DELETE /research-common/api/v1/special-review-approval-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- approvalTypeCode
string(optional)Special Review Approval Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Special Review Types ¶
Get Special Review Types by KeyGET/research-common/api/v1/special-review-types/(key)
Example URI
GET /research-common/api/v1/special-review-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Get All Special Review TypesGET/research-common/api/v1/special-review-types/
Example URI
GET /research-common/api/v1/special-review-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Get All Special Review Types with FilteringGET/research-common/api/v1/special-review-types/
Example URI
GET /research-common/api/v1/special-review-types/
URI Parameters
- specialReviewTypeCode
string(optional)Special Review Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- sortId
string(optional)Sort ID. Maximum length is 12.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Special Review TypesGET/research-common/api/v1/special-review-types/
Example URI
GET /research-common/api/v1/special-review-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"specialReviewTypeCode",
"description",
"sortId"
],
"primaryKey": "specialReviewTypeCode"
}Get Blueprint API specification for Special Review TypesGET/research-common/api/v1/special-review-types/
Example URI
GET /research-common/api/v1/special-review-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Special Review Types.md"
transfer-encoding: chunkedUpdate Special Review TypesPUT/research-common/api/v1/special-review-types/(key)
Example URI
PUT /research-common/api/v1/special-review-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Special Review TypesPUT/research-common/api/v1/special-review-types/
Example URI
PUT /research-common/api/v1/special-review-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Special Review TypesPATCH/research-common/api/v1/special-review-types/(key)
Example URI
PATCH /research-common/api/v1/special-review-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Insert Special Review TypesPOST/research-common/api/v1/special-review-types/
Example URI
POST /research-common/api/v1/special-review-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Special Review TypesPOST/research-common/api/v1/special-review-types/
Example URI
POST /research-common/api/v1/special-review-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"specialReviewTypeCode": "(val)",
"description": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Delete Special Review Types by KeyDELETE/research-common/api/v1/special-review-types/(key)
Example URI
DELETE /research-common/api/v1/special-review-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Special Review TypesDELETE/research-common/api/v1/special-review-types/
Example URI
DELETE /research-common/api/v1/special-review-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Special Review Types with MatchingDELETE/research-common/api/v1/special-review-types/
Example URI
DELETE /research-common/api/v1/special-review-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- specialReviewTypeCode
string(optional)Special Review Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- sortId
string(optional)Sort ID. Maximum length is 12.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Special Review Usages ¶
Get Special Review Usages by KeyGET/research-common/api/v1/special-review-usages/(key)
Example URI
GET /research-common/api/v1/special-review-usages/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Special Review UsagesGET/research-common/api/v1/special-review-usages/
Example URI
GET /research-common/api/v1/special-review-usages/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Special Review Usages with FilteringGET/research-common/api/v1/special-review-usages/
Example URI
GET /research-common/api/v1/special-review-usages/
URI Parameters
- specialReviewUsageId
string(optional)Special Review Usage Id. Maximum length is 12.
- specialReviewTypeCode
string(optional)Special Review Type Code. Maximum length is 3.
- moduleCode
string(optional)Module Code. Maximum length is 4.
- global
string(optional)Global. Maximum length is 1.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Special Review UsagesGET/research-common/api/v1/special-review-usages/
Example URI
GET /research-common/api/v1/special-review-usages/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"specialReviewUsageId",
"specialReviewTypeCode",
"moduleCode",
"global",
"active"
],
"primaryKey": "specialReviewUsageId"
}Get Blueprint API specification for Special Review UsagesGET/research-common/api/v1/special-review-usages/
Example URI
GET /research-common/api/v1/special-review-usages/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Special Review Usages.md"
transfer-encoding: chunkedUpdate Special Review UsagesPUT/research-common/api/v1/special-review-usages/(key)
Example URI
PUT /research-common/api/v1/special-review-usages/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Special Review UsagesPUT/research-common/api/v1/special-review-usages/
Example URI
PUT /research-common/api/v1/special-review-usages/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Special Review UsagesPATCH/research-common/api/v1/special-review-usages/(key)
Example URI
PATCH /research-common/api/v1/special-review-usages/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Special Review UsagesPOST/research-common/api/v1/special-review-usages/
Example URI
POST /research-common/api/v1/special-review-usages/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Special Review UsagesPOST/research-common/api/v1/special-review-usages/
Example URI
POST /research-common/api/v1/special-review-usages/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"specialReviewUsageId": "(val)",
"specialReviewTypeCode": "(val)",
"moduleCode": "(val)",
"global": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Special Review Usages by KeyDELETE/research-common/api/v1/special-review-usages/(key)
Example URI
DELETE /research-common/api/v1/special-review-usages/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Special Review UsagesDELETE/research-common/api/v1/special-review-usages/
Example URI
DELETE /research-common/api/v1/special-review-usages/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Special Review Usages with MatchingDELETE/research-common/api/v1/special-review-usages/
Example URI
DELETE /research-common/api/v1/special-review-usages/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- specialReviewUsageId
string(optional)Special Review Usage Id. Maximum length is 12.
- specialReviewTypeCode
string(optional)Special Review Type Code. Maximum length is 3.
- moduleCode
string(optional)Module Code. Maximum length is 4.
- global
string(optional)Global. Maximum length is 1.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Sponsor Form Template Lists ¶
Get Sponsor Form Template Lists by KeyGET/research-common/api/v1/sponsor-form-template-lists/(key)
Example URI
GET /research-common/api/v1/sponsor-form-template-lists/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
}Get All Sponsor Form Template ListsGET/research-common/api/v1/sponsor-form-template-lists/
Example URI
GET /research-common/api/v1/sponsor-form-template-lists/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
}
]Get All Sponsor Form Template Lists with FilteringGET/research-common/api/v1/sponsor-form-template-lists/
Example URI
GET /research-common/api/v1/sponsor-form-template-lists/
URI Parameters
- sponsorFormTemplateId
string(optional)- sponsorFormId
string(optional)- pageNumber
string(optional)- pageDescription
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sponsor Form Template ListsGET/research-common/api/v1/sponsor-form-template-lists/
Example URI
GET /research-common/api/v1/sponsor-form-template-lists/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"sponsorFormTemplateId",
"sponsorFormId",
"pageNumber",
"pageDescription"
],
"primaryKey": "sponsorFormTemplateId"
}Get Blueprint API specification for Sponsor Form Template ListsGET/research-common/api/v1/sponsor-form-template-lists/
Example URI
GET /research-common/api/v1/sponsor-form-template-lists/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sponsor Form Template Lists.md"
transfer-encoding: chunkedUpdate Sponsor Form Template ListsPUT/research-common/api/v1/sponsor-form-template-lists/(key)
Example URI
PUT /research-common/api/v1/sponsor-form-template-lists/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Sponsor Form Template ListsPUT/research-common/api/v1/sponsor-form-template-lists/
Example URI
PUT /research-common/api/v1/sponsor-form-template-lists/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Sponsor Form Template ListsPATCH/research-common/api/v1/sponsor-form-template-lists/(key)
Example URI
PATCH /research-common/api/v1/sponsor-form-template-lists/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
}Insert Sponsor Form Template ListsPOST/research-common/api/v1/sponsor-form-template-lists/
Example URI
POST /research-common/api/v1/sponsor-form-template-lists/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sponsor Form Template ListsPOST/research-common/api/v1/sponsor-form-template-lists/
Example URI
POST /research-common/api/v1/sponsor-form-template-lists/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"pageNumber": "(val)",
"pageDescription": "(val)",
"_primaryKey": "(val)"
}
]Delete Sponsor Form Template Lists by KeyDELETE/research-common/api/v1/sponsor-form-template-lists/(key)
Example URI
DELETE /research-common/api/v1/sponsor-form-template-lists/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor Form Template ListsDELETE/research-common/api/v1/sponsor-form-template-lists/
Example URI
DELETE /research-common/api/v1/sponsor-form-template-lists/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor Form Template Lists with MatchingDELETE/research-common/api/v1/sponsor-form-template-lists/
Example URI
DELETE /research-common/api/v1/sponsor-form-template-lists/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- sponsorFormTemplateId
string(optional)- sponsorFormId
string(optional)- pageNumber
string(optional)- pageDescription
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Sponsor Form Templates ¶
Get Sponsor Form Templates by KeyGET/research-common/api/v1/sponsor-form-templates/(key)
Example URI
GET /research-common/api/v1/sponsor-form-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}Get All Sponsor Form TemplatesGET/research-common/api/v1/sponsor-form-templates/
Example URI
GET /research-common/api/v1/sponsor-form-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}
]Get All Sponsor Form Templates with FilteringGET/research-common/api/v1/sponsor-form-templates/
Example URI
GET /research-common/api/v1/sponsor-form-templates/
URI Parameters
- sponsorFormTemplateId
string(optional)Sponsor Form Template Id. Maximum length is 12.
- sponsorFormId
string(optional)Sponsor Form Id. Maximum length is 12.
- attachmentContent
string(optional)- pageDescription
string(optional)Page Description. Maximum length is 200.
- pageNumber
string(optional)Page Number. Maximum length is 3.
- fileName
string(optional)- contentType
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sponsor Form TemplatesGET/research-common/api/v1/sponsor-form-templates/
Example URI
GET /research-common/api/v1/sponsor-form-templates/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"sponsorFormTemplateId",
"sponsorFormId",
"attachmentContent",
"pageDescription",
"pageNumber",
"fileName",
"contentType"
],
"primaryKey": "sponsorFormTemplateId"
}Get Blueprint API specification for Sponsor Form TemplatesGET/research-common/api/v1/sponsor-form-templates/
Example URI
GET /research-common/api/v1/sponsor-form-templates/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sponsor Form Templates.md"
transfer-encoding: chunkedUpdate Sponsor Form TemplatesPUT/research-common/api/v1/sponsor-form-templates/(key)
Example URI
PUT /research-common/api/v1/sponsor-form-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Sponsor Form TemplatesPUT/research-common/api/v1/sponsor-form-templates/
Example URI
PUT /research-common/api/v1/sponsor-form-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Sponsor Form TemplatesPATCH/research-common/api/v1/sponsor-form-templates/(key)
Example URI
PATCH /research-common/api/v1/sponsor-form-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}Insert Sponsor Form TemplatesPOST/research-common/api/v1/sponsor-form-templates/
Example URI
POST /research-common/api/v1/sponsor-form-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sponsor Form TemplatesPOST/research-common/api/v1/sponsor-form-templates/
Example URI
POST /research-common/api/v1/sponsor-form-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormTemplateId": "(val)",
"sponsorFormId": "(val)",
"attachmentContent": "(val)",
"pageDescription": "(val)",
"pageNumber": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"_primaryKey": "(val)"
}
]Delete Sponsor Form Templates by KeyDELETE/research-common/api/v1/sponsor-form-templates/(key)
Example URI
DELETE /research-common/api/v1/sponsor-form-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor Form TemplatesDELETE/research-common/api/v1/sponsor-form-templates/
Example URI
DELETE /research-common/api/v1/sponsor-form-templates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor Form Templates with MatchingDELETE/research-common/api/v1/sponsor-form-templates/
Example URI
DELETE /research-common/api/v1/sponsor-form-templates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- sponsorFormTemplateId
string(optional)Sponsor Form Template Id. Maximum length is 12.
- sponsorFormId
string(optional)Sponsor Form Id. Maximum length is 12.
- attachmentContent
string(optional)- pageDescription
string(optional)Page Description. Maximum length is 200.
- pageNumber
string(optional)Page Number. Maximum length is 3.
- fileName
string(optional)- contentType
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Sponsor Forms ¶
Get Sponsor Forms by KeyGET/research-common/api/v1/sponsor-forms/(key)
Example URI
GET /research-common/api/v1/sponsor-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
}Get All Sponsor FormsGET/research-common/api/v1/sponsor-forms/
Example URI
GET /research-common/api/v1/sponsor-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
}
]Get All Sponsor Forms with FilteringGET/research-common/api/v1/sponsor-forms/
Example URI
GET /research-common/api/v1/sponsor-forms/
URI Parameters
- sponsorFormId
string(optional)Sponsor Form Id. Maximum length is 12.
- packageName
string(optional)Package Name. Maximum length is 200.
- packageNumber
string(optional)Package Number. Maximum length is 3.
- sponsorCode
string(optional)Sponsor Code. Maximum length is 6.
- sponsorHierarchyName
string(optional)Sponsor Hierarchy Group Name. Maximum length is 50.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sponsor FormsGET/research-common/api/v1/sponsor-forms/
Example URI
GET /research-common/api/v1/sponsor-forms/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"sponsorFormId",
"packageName",
"packageNumber",
"sponsorCode",
"sponsorHierarchyName"
],
"primaryKey": "sponsorFormId"
}Get Blueprint API specification for Sponsor FormsGET/research-common/api/v1/sponsor-forms/
Example URI
GET /research-common/api/v1/sponsor-forms/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sponsor Forms.md"
transfer-encoding: chunkedUpdate Sponsor FormsPUT/research-common/api/v1/sponsor-forms/(key)
Example URI
PUT /research-common/api/v1/sponsor-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Sponsor FormsPUT/research-common/api/v1/sponsor-forms/
Example URI
PUT /research-common/api/v1/sponsor-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Sponsor FormsPATCH/research-common/api/v1/sponsor-forms/(key)
Example URI
PATCH /research-common/api/v1/sponsor-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
}Insert Sponsor FormsPOST/research-common/api/v1/sponsor-forms/
Example URI
POST /research-common/api/v1/sponsor-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sponsor FormsPOST/research-common/api/v1/sponsor-forms/
Example URI
POST /research-common/api/v1/sponsor-forms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorFormId": "(val)",
"packageName": "(val)",
"packageNumber": "(val)",
"sponsorCode": "(val)",
"sponsorHierarchyName": "(val)",
"_primaryKey": "(val)"
}
]Delete Sponsor Forms by KeyDELETE/research-common/api/v1/sponsor-forms/(key)
Example URI
DELETE /research-common/api/v1/sponsor-forms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor FormsDELETE/research-common/api/v1/sponsor-forms/
Example URI
DELETE /research-common/api/v1/sponsor-forms/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor Forms with MatchingDELETE/research-common/api/v1/sponsor-forms/
Example URI
DELETE /research-common/api/v1/sponsor-forms/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- sponsorFormId
string(optional)Sponsor Form Id. Maximum length is 12.
- packageName
string(optional)Package Name. Maximum length is 200.
- packageNumber
string(optional)Package Number. Maximum length is 3.
- sponsorCode
string(optional)Sponsor Code. Maximum length is 6.
- sponsorHierarchyName
string(optional)Sponsor Hierarchy Group Name. Maximum length is 50.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Sponsor Hierarchies ¶
Get Sponsor Hierarchies by KeyGET/research-common/api/v1/sponsor-hierarchies/(key)
Example URI
GET /research-common/api/v1/sponsor-hierarchies/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
}Get All Sponsor HierarchiesGET/research-common/api/v1/sponsor-hierarchies/
Example URI
GET /research-common/api/v1/sponsor-hierarchies/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
},
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
}
]Get All Sponsor Hierarchies with FilteringGET/research-common/api/v1/sponsor-hierarchies/
Example URI
GET /research-common/api/v1/sponsor-hierarchies/
URI Parameters
- hierarchyName
string(optional)Hierarchy Name. Maximum length is 100.
- sponsorCode
string(optional)Sponsor Code. Maximum length is 6.
- level1
string(optional)Level1. Maximum length is 50.
- level10
string(optional)Level10. Maximum length is 50.
- level10Sortid
string(optional)Level10 Sortid. Maximum length is 4.
- level1Sortid
string(optional)Level1 Sortid. Maximum length is 4.
- level2
string(optional)Level2. Maximum length is 50.
- level2Sortid
string(optional)Level2 Sortid. Maximum length is 4.
- level3
string(optional)Level3. Maximum length is 50.
- level3Sortid
string(optional)Level3 Sortid. Maximum length is 4.
- level4
string(optional)Level4. Maximum length is 50.
- level4Sortid
string(optional)Level4 Sortid. Maximum length is 4.
- level5
string(optional)Level5. Maximum length is 50.
- level5Sortid
string(optional)Level5 Sortid. Maximum length is 4.
- level6
string(optional)Level6. Maximum length is 50.
- level6Sortid
string(optional)Level6 Sortid. Maximum length is 4.
- level7
string(optional)Level7. Maximum length is 50.
- level7Sortid
string(optional)Level7 Sortid. Maximum length is 4.
- level8
string(optional)Level8. Maximum length is 50.
- level8Sortid
string(optional)Level8 Sortid. Maximum length is 4.
- level9
string(optional)Level9. Maximum length is 50.
- level9Sortid
string(optional)Level9 Sortid. Maximum length is 4.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
},
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sponsor HierarchiesGET/research-common/api/v1/sponsor-hierarchies/
Example URI
GET /research-common/api/v1/sponsor-hierarchies/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"hierarchyName",
"sponsorCode",
"level1",
"level10",
"level10Sortid",
"level1Sortid",
"level2",
"level2Sortid",
"level3",
"level3Sortid",
"level4",
"level4Sortid",
"level5",
"level5Sortid",
"level6",
"level6Sortid",
"level7",
"level7Sortid",
"level8",
"level8Sortid",
"level9",
"level9Sortid"
],
"primaryKey": "hierarchyName:sponsorCode"
}Get Blueprint API specification for Sponsor HierarchiesGET/research-common/api/v1/sponsor-hierarchies/
Example URI
GET /research-common/api/v1/sponsor-hierarchies/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sponsor Hierarchies.md"
transfer-encoding: chunkedUpdate Sponsor HierarchiesPUT/research-common/api/v1/sponsor-hierarchies/(key)
Example URI
PUT /research-common/api/v1/sponsor-hierarchies/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Sponsor HierarchiesPUT/research-common/api/v1/sponsor-hierarchies/
Example URI
PUT /research-common/api/v1/sponsor-hierarchies/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
},
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Sponsor HierarchiesPATCH/research-common/api/v1/sponsor-hierarchies/(key)
Example URI
PATCH /research-common/api/v1/sponsor-hierarchies/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
}Insert Sponsor HierarchiesPOST/research-common/api/v1/sponsor-hierarchies/
Example URI
POST /research-common/api/v1/sponsor-hierarchies/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sponsor HierarchiesPOST/research-common/api/v1/sponsor-hierarchies/
Example URI
POST /research-common/api/v1/sponsor-hierarchies/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
},
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
},
{
"hierarchyName": "(val)",
"sponsorCode": "(val)",
"level1": "(val)",
"level10": "(val)",
"level10Sortid": "(val)",
"level1Sortid": "(val)",
"level2": "(val)",
"level2Sortid": "(val)",
"level3": "(val)",
"level3Sortid": "(val)",
"level4": "(val)",
"level4Sortid": "(val)",
"level5": "(val)",
"level5Sortid": "(val)",
"level6": "(val)",
"level6Sortid": "(val)",
"level7": "(val)",
"level7Sortid": "(val)",
"level8": "(val)",
"level8Sortid": "(val)",
"level9": "(val)",
"level9Sortid": "(val)",
"_primaryKey": "(val)"
}
]Delete Sponsor Hierarchies by KeyDELETE/research-common/api/v1/sponsor-hierarchies/(key)
Example URI
DELETE /research-common/api/v1/sponsor-hierarchies/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor HierarchiesDELETE/research-common/api/v1/sponsor-hierarchies/
Example URI
DELETE /research-common/api/v1/sponsor-hierarchies/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor Hierarchies with MatchingDELETE/research-common/api/v1/sponsor-hierarchies/
Example URI
DELETE /research-common/api/v1/sponsor-hierarchies/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- hierarchyName
string(optional)Hierarchy Name. Maximum length is 100.
- sponsorCode
string(optional)Sponsor Code. Maximum length is 6.
- level1
string(optional)Level1. Maximum length is 50.
- level10
string(optional)Level10. Maximum length is 50.
- level10Sortid
string(optional)Level10 Sortid. Maximum length is 4.
- level1Sortid
string(optional)Level1 Sortid. Maximum length is 4.
- level2
string(optional)Level2. Maximum length is 50.
- level2Sortid
string(optional)Level2 Sortid. Maximum length is 4.
- level3
string(optional)Level3. Maximum length is 50.
- level3Sortid
string(optional)Level3 Sortid. Maximum length is 4.
- level4
string(optional)Level4. Maximum length is 50.
- level4Sortid
string(optional)Level4 Sortid. Maximum length is 4.
- level5
string(optional)Level5. Maximum length is 50.
- level5Sortid
string(optional)Level5 Sortid. Maximum length is 4.
- level6
string(optional)Level6. Maximum length is 50.
- level6Sortid
string(optional)Level6 Sortid. Maximum length is 4.
- level7
string(optional)Level7. Maximum length is 50.
- level7Sortid
string(optional)Level7 Sortid. Maximum length is 4.
- level8
string(optional)Level8. Maximum length is 50.
- level8Sortid
string(optional)Level8 Sortid. Maximum length is 4.
- level9
string(optional)Level9. Maximum length is 50.
- level9Sortid
string(optional)Level9 Sortid. Maximum length is 4.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Sponsor Term Types ¶
Get Sponsor Term Types by KeyGET/research-common/api/v1/sponsor-term-types/(key)
Example URI
GET /research-common/api/v1/sponsor-term-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Sponsor Term TypesGET/research-common/api/v1/sponsor-term-types/
Example URI
GET /research-common/api/v1/sponsor-term-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Sponsor Term Types with FilteringGET/research-common/api/v1/sponsor-term-types/
Example URI
GET /research-common/api/v1/sponsor-term-types/
URI Parameters
- sponsorTermTypeCode
string(optional)Sponsor Term Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sponsor Term TypesGET/research-common/api/v1/sponsor-term-types/
Example URI
GET /research-common/api/v1/sponsor-term-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"sponsorTermTypeCode",
"description"
],
"primaryKey": "sponsorTermTypeCode"
}Get Blueprint API specification for Sponsor Term TypesGET/research-common/api/v1/sponsor-term-types/
Example URI
GET /research-common/api/v1/sponsor-term-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sponsor Term Types.md"
transfer-encoding: chunkedUpdate Sponsor Term TypesPUT/research-common/api/v1/sponsor-term-types/(key)
Example URI
PUT /research-common/api/v1/sponsor-term-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Sponsor Term TypesPUT/research-common/api/v1/sponsor-term-types/
Example URI
PUT /research-common/api/v1/sponsor-term-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Sponsor Term TypesPATCH/research-common/api/v1/sponsor-term-types/(key)
Example URI
PATCH /research-common/api/v1/sponsor-term-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Sponsor Term TypesPOST/research-common/api/v1/sponsor-term-types/
Example URI
POST /research-common/api/v1/sponsor-term-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sponsor Term TypesPOST/research-common/api/v1/sponsor-term-types/
Example URI
POST /research-common/api/v1/sponsor-term-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Sponsor Term Types by KeyDELETE/research-common/api/v1/sponsor-term-types/(key)
Example URI
DELETE /research-common/api/v1/sponsor-term-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor Term TypesDELETE/research-common/api/v1/sponsor-term-types/
Example URI
DELETE /research-common/api/v1/sponsor-term-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor Term Types with MatchingDELETE/research-common/api/v1/sponsor-term-types/
Example URI
DELETE /research-common/api/v1/sponsor-term-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- sponsorTermTypeCode
string(optional)Sponsor Term Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Sponsor Terms ¶
Get Sponsor Terms by KeyGET/research-common/api/v1/sponsor-terms/(key)
Example URI
GET /research-common/api/v1/sponsor-terms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Sponsor TermsGET/research-common/api/v1/sponsor-terms/
Example URI
GET /research-common/api/v1/sponsor-terms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Sponsor Terms with FilteringGET/research-common/api/v1/sponsor-terms/
Example URI
GET /research-common/api/v1/sponsor-terms/
URI Parameters
- sponsorTermId
string(optional)Sponsor Term Id. Maximum length is 22.
- sponsorTermCode
string(optional)Sponsor Term Code. Maximum length is 3.
- sponsorTermTypeCode
string(optional)Sponsor Term Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sponsor TermsGET/research-common/api/v1/sponsor-terms/
Example URI
GET /research-common/api/v1/sponsor-terms/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"sponsorTermId",
"sponsorTermCode",
"sponsorTermTypeCode",
"description"
],
"primaryKey": "sponsorTermId"
}Get Blueprint API specification for Sponsor TermsGET/research-common/api/v1/sponsor-terms/
Example URI
GET /research-common/api/v1/sponsor-terms/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sponsor Terms.md"
transfer-encoding: chunkedUpdate Sponsor TermsPUT/research-common/api/v1/sponsor-terms/(key)
Example URI
PUT /research-common/api/v1/sponsor-terms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Sponsor TermsPUT/research-common/api/v1/sponsor-terms/
Example URI
PUT /research-common/api/v1/sponsor-terms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Sponsor TermsPATCH/research-common/api/v1/sponsor-terms/(key)
Example URI
PATCH /research-common/api/v1/sponsor-terms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Sponsor TermsPOST/research-common/api/v1/sponsor-terms/
Example URI
POST /research-common/api/v1/sponsor-terms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sponsor TermsPOST/research-common/api/v1/sponsor-terms/
Example URI
POST /research-common/api/v1/sponsor-terms/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorTermId": "(val)",
"sponsorTermCode": "(val)",
"sponsorTermTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Sponsor Terms by KeyDELETE/research-common/api/v1/sponsor-terms/(key)
Example URI
DELETE /research-common/api/v1/sponsor-terms/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor TermsDELETE/research-common/api/v1/sponsor-terms/
Example URI
DELETE /research-common/api/v1/sponsor-terms/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor Terms with MatchingDELETE/research-common/api/v1/sponsor-terms/
Example URI
DELETE /research-common/api/v1/sponsor-terms/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- sponsorTermId
string(optional)Sponsor Term Id. Maximum length is 22.
- sponsorTermCode
string(optional)Sponsor Term Code. Maximum length is 3.
- sponsorTermTypeCode
string(optional)Sponsor Term Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Sponsor Types ¶
Get Sponsor Types by KeyGET/research-common/api/v1/sponsor-types/(key)
Example URI
GET /research-common/api/v1/sponsor-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Sponsor TypesGET/research-common/api/v1/sponsor-types/
Example URI
GET /research-common/api/v1/sponsor-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Sponsor Types with FilteringGET/research-common/api/v1/sponsor-types/
Example URI
GET /research-common/api/v1/sponsor-types/
URI Parameters
- code
string(optional)Sponsor Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 100.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Sponsor TypesGET/research-common/api/v1/sponsor-types/
Example URI
GET /research-common/api/v1/sponsor-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Sponsor TypesGET/research-common/api/v1/sponsor-types/
Example URI
GET /research-common/api/v1/sponsor-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sponsor Types.md"
transfer-encoding: chunkedUpdate Sponsor TypesPUT/research-common/api/v1/sponsor-types/(key)
Example URI
PUT /research-common/api/v1/sponsor-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Sponsor TypesPUT/research-common/api/v1/sponsor-types/
Example URI
PUT /research-common/api/v1/sponsor-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Sponsor TypesPATCH/research-common/api/v1/sponsor-types/(key)
Example URI
PATCH /research-common/api/v1/sponsor-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Sponsor TypesPOST/research-common/api/v1/sponsor-types/
Example URI
POST /research-common/api/v1/sponsor-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Sponsor TypesPOST/research-common/api/v1/sponsor-types/
Example URI
POST /research-common/api/v1/sponsor-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Sponsor Types by KeyDELETE/research-common/api/v1/sponsor-types/(key)
Example URI
DELETE /research-common/api/v1/sponsor-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor TypesDELETE/research-common/api/v1/sponsor-types/
Example URI
DELETE /research-common/api/v1/sponsor-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsor Types with MatchingDELETE/research-common/api/v1/sponsor-types/
Example URI
DELETE /research-common/api/v1/sponsor-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Sponsor Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 100.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Sponsors ¶
Get Sponsors by KeyGET/research-common/api/v1/sponsors/(key)
Example URI
GET /research-common/api/v1/sponsors/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All SponsorsGET/research-common/api/v1/sponsors/
Example URI
GET /research-common/api/v1/sponsors/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Sponsors with FilteringGET/research-common/api/v1/sponsors/
Example URI
GET /research-common/api/v1/sponsors/
URI Parameters
- sponsorCode
string(optional)Sponsor Code. Maximum length is 6.
- acronym
string(optional)Acronym. Maximum length is 10.
- auditReportSentForFy
string(optional)Audit Report Sent For Fy. Maximum length is 4.
- cageNumber
string(optional)CAGE Number. Maximum length is 20.
- countryCode
string(optional)Country Code. Maximum length is 3.
- dodacNumber
string(optional)DODAC Number. Maximum length is 20.
- dunAndBradstreetNumber
string(optional)DUN And Bradstreet Number. Maximum length is 20.
- dunsPlusFourNumber
string(optional)DUNS Plus Four Number. Maximum length is 20.
- ownedByUnit
string(optional)Owned By Unit. Maximum length is 8.
- postalCode
string(optional)Postal Code. Maximum length is 15.
- rolodexId
string(optional)Rolodex Id. Maximum length is 6.
- sponsorName
string(optional)The name of the sponsoring agency. Maximum length is 200.
- sponsorTypeCode
string(optional)Sponsor Type Code. Maximum length is 3.
- state
string(optional)State. Maximum length is 30.
- createUser
string(optional)Create User.
- dunningCampaignId
string(optional)Dunning Campaign ID. Maximum length is 4.
- customerNumber
string(optional)Customer Number. Maximum length is 40.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for SponsorsGET/research-common/api/v1/sponsors/
Example URI
GET /research-common/api/v1/sponsors/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"sponsorCode",
"acronym",
"auditReportSentForFy",
"cageNumber",
"countryCode",
"dodacNumber",
"dunAndBradstreetNumber",
"dunsPlusFourNumber",
"ownedByUnit",
"postalCode",
"rolodexId",
"sponsorName",
"sponsorTypeCode",
"state",
"createUser",
"dunningCampaignId",
"customerNumber",
"active"
],
"primaryKey": "sponsorCode"
}Get Blueprint API specification for SponsorsGET/research-common/api/v1/sponsors/
Example URI
GET /research-common/api/v1/sponsors/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Sponsors.md"
transfer-encoding: chunkedUpdate SponsorsPUT/research-common/api/v1/sponsors/(key)
Example URI
PUT /research-common/api/v1/sponsors/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple SponsorsPUT/research-common/api/v1/sponsors/
Example URI
PUT /research-common/api/v1/sponsors/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes SponsorsPATCH/research-common/api/v1/sponsors/(key)
Example URI
PATCH /research-common/api/v1/sponsors/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert SponsorsPOST/research-common/api/v1/sponsors/
Example URI
POST /research-common/api/v1/sponsors/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple SponsorsPOST/research-common/api/v1/sponsors/
Example URI
POST /research-common/api/v1/sponsors/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"sponsorCode": "(val)",
"acronym": "(val)",
"auditReportSentForFy": "(val)",
"cageNumber": "(val)",
"countryCode": "(val)",
"dodacNumber": "(val)",
"dunAndBradstreetNumber": "(val)",
"dunsPlusFourNumber": "(val)",
"ownedByUnit": "(val)",
"postalCode": "(val)",
"rolodexId": "(val)",
"sponsorName": "(val)",
"sponsorTypeCode": "(val)",
"state": "(val)",
"createUser": "(val)",
"dunningCampaignId": "(val)",
"customerNumber": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Sponsors by KeyDELETE/research-common/api/v1/sponsors/(key)
Example URI
DELETE /research-common/api/v1/sponsors/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All SponsorsDELETE/research-common/api/v1/sponsors/
Example URI
DELETE /research-common/api/v1/sponsors/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Sponsors with MatchingDELETE/research-common/api/v1/sponsors/
Example URI
DELETE /research-common/api/v1/sponsors/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- sponsorCode
string(optional)Sponsor Code. Maximum length is 6.
- acronym
string(optional)Acronym. Maximum length is 10.
- auditReportSentForFy
string(optional)Audit Report Sent For Fy. Maximum length is 4.
- cageNumber
string(optional)CAGE Number. Maximum length is 20.
- countryCode
string(optional)Country Code. Maximum length is 3.
- dodacNumber
string(optional)DODAC Number. Maximum length is 20.
- dunAndBradstreetNumber
string(optional)DUN And Bradstreet Number. Maximum length is 20.
- dunsPlusFourNumber
string(optional)DUNS Plus Four Number. Maximum length is 20.
- ownedByUnit
string(optional)Owned By Unit. Maximum length is 8.
- postalCode
string(optional)Postal Code. Maximum length is 15.
- rolodexId
string(optional)Rolodex Id. Maximum length is 6.
- sponsorName
string(optional)The name of the sponsoring agency. Maximum length is 200.
- sponsorTypeCode
string(optional)Sponsor Type Code. Maximum length is 3.
- state
string(optional)State. Maximum length is 30.
- createUser
string(optional)Create User.
- dunningCampaignId
string(optional)Dunning Campaign ID. Maximum length is 4.
- customerNumber
string(optional)Customer Number. Maximum length is 40.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Tbn Persons ¶
Get Tbn Persons by KeyGET/research-common/api/v1/tbn-persons/(key)
Example URI
GET /research-common/api/v1/tbn-persons/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Tbn PersonsGET/research-common/api/v1/tbn-persons/
Example URI
GET /research-common/api/v1/tbn-persons/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Tbn Persons with FilteringGET/research-common/api/v1/tbn-persons/
Example URI
GET /research-common/api/v1/tbn-persons/
URI Parameters
- tbnId
string(optional)TBN Id. Maximum length is 9.
- personName
string(optional)Person Name. Maximum length is 90.
- jobCode
string(optional)Job Code. Maximum length is 6.
- active
string(optional)Is Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Tbn PersonsGET/research-common/api/v1/tbn-persons/
Example URI
GET /research-common/api/v1/tbn-persons/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"tbnId",
"personName",
"jobCode",
"active"
],
"primaryKey": "tbnId"
}Get Blueprint API specification for Tbn PersonsGET/research-common/api/v1/tbn-persons/
Example URI
GET /research-common/api/v1/tbn-persons/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Tbn Persons.md"
transfer-encoding: chunkedUpdate Tbn PersonsPUT/research-common/api/v1/tbn-persons/(key)
Example URI
PUT /research-common/api/v1/tbn-persons/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Tbn PersonsPUT/research-common/api/v1/tbn-persons/
Example URI
PUT /research-common/api/v1/tbn-persons/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Tbn PersonsPATCH/research-common/api/v1/tbn-persons/(key)
Example URI
PATCH /research-common/api/v1/tbn-persons/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Tbn PersonsPOST/research-common/api/v1/tbn-persons/
Example URI
POST /research-common/api/v1/tbn-persons/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Tbn PersonsPOST/research-common/api/v1/tbn-persons/
Example URI
POST /research-common/api/v1/tbn-persons/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"tbnId": "(val)",
"personName": "(val)",
"jobCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Tbn Persons by KeyDELETE/research-common/api/v1/tbn-persons/(key)
Example URI
DELETE /research-common/api/v1/tbn-persons/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Tbn PersonsDELETE/research-common/api/v1/tbn-persons/
Example URI
DELETE /research-common/api/v1/tbn-persons/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Tbn Persons with MatchingDELETE/research-common/api/v1/tbn-persons/
Example URI
DELETE /research-common/api/v1/tbn-persons/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- tbnId
string(optional)TBN Id. Maximum length is 9.
- personName
string(optional)Person Name. Maximum length is 90.
- jobCode
string(optional)Job Code. Maximum length is 6.
- active
string(optional)Is Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Training Stipend Rates ¶
Get Training Stipend Rates by KeyGET/research-common/api/v1/training-stipend-rates/(key)
Example URI
GET /research-common/api/v1/training-stipend-rates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Training Stipend RatesGET/research-common/api/v1/training-stipend-rates/
Example URI
GET /research-common/api/v1/training-stipend-rates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Training Stipend Rates with FilteringGET/research-common/api/v1/training-stipend-rates/
Example URI
GET /research-common/api/v1/training-stipend-rates/
URI Parameters
- id
string(optional)Id. Maximum length is 12.
- careerLevel
string(optional)Career Level. Maximum length is 20.
- experienceLevel
string(optional)Experience Level. Maximum length is 3.
- stipendRate
string(optional)Stipend Rate. Maximum length is 10.
- effectiveDate
string(optional)Effective Date. Maximum length is 21.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Training Stipend RatesGET/research-common/api/v1/training-stipend-rates/
Example URI
GET /research-common/api/v1/training-stipend-rates/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"careerLevel",
"experienceLevel",
"stipendRate",
"effectiveDate",
"description"
],
"primaryKey": "id"
}Get Blueprint API specification for Training Stipend RatesGET/research-common/api/v1/training-stipend-rates/
Example URI
GET /research-common/api/v1/training-stipend-rates/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Training Stipend Rates.md"
transfer-encoding: chunkedUpdate Training Stipend RatesPUT/research-common/api/v1/training-stipend-rates/(key)
Example URI
PUT /research-common/api/v1/training-stipend-rates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Training Stipend RatesPUT/research-common/api/v1/training-stipend-rates/
Example URI
PUT /research-common/api/v1/training-stipend-rates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Training Stipend RatesPATCH/research-common/api/v1/training-stipend-rates/(key)
Example URI
PATCH /research-common/api/v1/training-stipend-rates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Training Stipend RatesPOST/research-common/api/v1/training-stipend-rates/
Example URI
POST /research-common/api/v1/training-stipend-rates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Training Stipend RatesPOST/research-common/api/v1/training-stipend-rates/
Example URI
POST /research-common/api/v1/training-stipend-rates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"careerLevel": "(val)",
"experienceLevel": "(val)",
"stipendRate": "(val)",
"effectiveDate": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Training Stipend Rates by KeyDELETE/research-common/api/v1/training-stipend-rates/(key)
Example URI
DELETE /research-common/api/v1/training-stipend-rates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Training Stipend RatesDELETE/research-common/api/v1/training-stipend-rates/
Example URI
DELETE /research-common/api/v1/training-stipend-rates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Training Stipend Rates with MatchingDELETE/research-common/api/v1/training-stipend-rates/
Example URI
DELETE /research-common/api/v1/training-stipend-rates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Id. Maximum length is 12.
- careerLevel
string(optional)Career Level. Maximum length is 20.
- experienceLevel
string(optional)Experience Level. Maximum length is 3.
- stipendRate
string(optional)Stipend Rate. Maximum length is 10.
- effectiveDate
string(optional)Effective Date. Maximum length is 21.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Trainings ¶
Get Trainings by KeyGET/research-common/api/v1/trainings/(key)
Example URI
GET /research-common/api/v1/trainings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All TrainingsGET/research-common/api/v1/trainings/
Example URI
GET /research-common/api/v1/trainings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Trainings with FilteringGET/research-common/api/v1/trainings/
Example URI
GET /research-common/api/v1/trainings/
URI Parameters
- trainingCode
string(optional)Training Code. Maximum length is 4.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for TrainingsGET/research-common/api/v1/trainings/
Example URI
GET /research-common/api/v1/trainings/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"trainingCode",
"description"
],
"primaryKey": "trainingCode"
}Get Blueprint API specification for TrainingsGET/research-common/api/v1/trainings/
Example URI
GET /research-common/api/v1/trainings/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Trainings.md"
transfer-encoding: chunkedUpdate TrainingsPUT/research-common/api/v1/trainings/(key)
Example URI
PUT /research-common/api/v1/trainings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple TrainingsPUT/research-common/api/v1/trainings/
Example URI
PUT /research-common/api/v1/trainings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes TrainingsPATCH/research-common/api/v1/trainings/(key)
Example URI
PATCH /research-common/api/v1/trainings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert TrainingsPOST/research-common/api/v1/trainings/
Example URI
POST /research-common/api/v1/trainings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple TrainingsPOST/research-common/api/v1/trainings/
Example URI
POST /research-common/api/v1/trainings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"trainingCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Trainings by KeyDELETE/research-common/api/v1/trainings/(key)
Example URI
DELETE /research-common/api/v1/trainings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All TrainingsDELETE/research-common/api/v1/trainings/
Example URI
DELETE /research-common/api/v1/trainings/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Trainings with MatchingDELETE/research-common/api/v1/trainings/
Example URI
DELETE /research-common/api/v1/trainings/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- trainingCode
string(optional)Training Code. Maximum length is 4.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Unit Administrator Person Mass Changes ¶
Get Unit Administrator Person Mass Changes by KeyGET/research-common/api/v1/unit-administrator-person-mass-changes/(key)
Example URI
GET /research-common/api/v1/unit-administrator-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
}Get All Unit Administrator Person Mass ChangesGET/research-common/api/v1/unit-administrator-person-mass-changes/
Example URI
GET /research-common/api/v1/unit-administrator-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
},
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
}
]Get All Unit Administrator Person Mass Changes with FilteringGET/research-common/api/v1/unit-administrator-person-mass-changes/
Example URI
GET /research-common/api/v1/unit-administrator-person-mass-changes/
URI Parameters
- unitAdministratorPersonMassChangeId
string(optional)Unit Administrator Person Mass Change Id. Maximum length is 12.
- personMassChangeId
string(optional)Person Mass Change Id. Maximum length is 12.
- administrativeOfficer
string(optional)Administrative Officer. Maximum length is 1.
- ospAdministrator
string(optional)OSP Administrator. Maximum length is 1.
- unitHead
string(optional)Unit Head. Maximum length is 1.
- deanVP
string(optional)Dean VP. Maximum length is 1.
- otherIndividualToNotify
string(optional)Other Individual to Notify. Maximum length is 1.
- administrativeContact
string(optional)Administrative Contact. Maximum length is 1.
- financialContact
string(optional)Financial Contact. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
},
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Unit Administrator Person Mass ChangesGET/research-common/api/v1/unit-administrator-person-mass-changes/
Example URI
GET /research-common/api/v1/unit-administrator-person-mass-changes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"unitAdministratorPersonMassChangeId",
"personMassChangeId",
"administrativeOfficer",
"ospAdministrator",
"unitHead",
"deanVP",
"otherIndividualToNotify",
"administrativeContact",
"financialContact"
],
"primaryKey": "unitAdministratorPersonMassChangeId"
}Get Blueprint API specification for Unit Administrator Person Mass ChangesGET/research-common/api/v1/unit-administrator-person-mass-changes/
Example URI
GET /research-common/api/v1/unit-administrator-person-mass-changes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Unit Administrator Person Mass Changes.md"
transfer-encoding: chunkedUpdate Unit Administrator Person Mass ChangesPUT/research-common/api/v1/unit-administrator-person-mass-changes/(key)
Example URI
PUT /research-common/api/v1/unit-administrator-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Unit Administrator Person Mass ChangesPUT/research-common/api/v1/unit-administrator-person-mass-changes/
Example URI
PUT /research-common/api/v1/unit-administrator-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
},
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Unit Administrator Person Mass ChangesPATCH/research-common/api/v1/unit-administrator-person-mass-changes/(key)
Example URI
PATCH /research-common/api/v1/unit-administrator-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
}Insert Unit Administrator Person Mass ChangesPOST/research-common/api/v1/unit-administrator-person-mass-changes/
Example URI
POST /research-common/api/v1/unit-administrator-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Unit Administrator Person Mass ChangesPOST/research-common/api/v1/unit-administrator-person-mass-changes/
Example URI
POST /research-common/api/v1/unit-administrator-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
},
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
},
{
"unitAdministratorPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"administrativeOfficer": "(val)",
"ospAdministrator": "(val)",
"unitHead": "(val)",
"deanVP": "(val)",
"otherIndividualToNotify": "(val)",
"administrativeContact": "(val)",
"financialContact": "(val)",
"_primaryKey": "(val)"
}
]Delete Unit Administrator Person Mass Changes by KeyDELETE/research-common/api/v1/unit-administrator-person-mass-changes/(key)
Example URI
DELETE /research-common/api/v1/unit-administrator-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Unit Administrator Person Mass ChangesDELETE/research-common/api/v1/unit-administrator-person-mass-changes/
Example URI
DELETE /research-common/api/v1/unit-administrator-person-mass-changes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Unit Administrator Person Mass Changes with MatchingDELETE/research-common/api/v1/unit-administrator-person-mass-changes/
Example URI
DELETE /research-common/api/v1/unit-administrator-person-mass-changes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- unitAdministratorPersonMassChangeId
string(optional)Unit Administrator Person Mass Change Id. Maximum length is 12.
- personMassChangeId
string(optional)Person Mass Change Id. Maximum length is 12.
- administrativeOfficer
string(optional)Administrative Officer. Maximum length is 1.
- ospAdministrator
string(optional)OSP Administrator. Maximum length is 1.
- unitHead
string(optional)Unit Head. Maximum length is 1.
- deanVP
string(optional)Dean VP. Maximum length is 1.
- otherIndividualToNotify
string(optional)Other Individual to Notify. Maximum length is 1.
- administrativeContact
string(optional)Administrative Contact. Maximum length is 1.
- financialContact
string(optional)Financial Contact. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Unit Administrator Types ¶
Get Unit Administrator Types by KeyGET/research-common/api/v1/unit-administrator-types/(key)
Example URI
GET /research-common/api/v1/unit-administrator-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
}Get All Unit Administrator TypesGET/research-common/api/v1/unit-administrator-types/
Example URI
GET /research-common/api/v1/unit-administrator-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
}
]Get All Unit Administrator Types with FilteringGET/research-common/api/v1/unit-administrator-types/
Example URI
GET /research-common/api/v1/unit-administrator-types/
URI Parameters
- code
string(optional)Unit Administrator Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- multiplesFlag
string(optional)Multiples Flag. Maximum length is 3.
- defaultGroupFlag
string(optional)Default Group Flag. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Unit Administrator TypesGET/research-common/api/v1/unit-administrator-types/
Example URI
GET /research-common/api/v1/unit-administrator-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description",
"multiplesFlag",
"defaultGroupFlag"
],
"primaryKey": "code"
}Get Blueprint API specification for Unit Administrator TypesGET/research-common/api/v1/unit-administrator-types/
Example URI
GET /research-common/api/v1/unit-administrator-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Unit Administrator Types.md"
transfer-encoding: chunkedUpdate Unit Administrator TypesPUT/research-common/api/v1/unit-administrator-types/(key)
Example URI
PUT /research-common/api/v1/unit-administrator-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Unit Administrator TypesPUT/research-common/api/v1/unit-administrator-types/
Example URI
PUT /research-common/api/v1/unit-administrator-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Unit Administrator TypesPATCH/research-common/api/v1/unit-administrator-types/(key)
Example URI
PATCH /research-common/api/v1/unit-administrator-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
}Insert Unit Administrator TypesPOST/research-common/api/v1/unit-administrator-types/
Example URI
POST /research-common/api/v1/unit-administrator-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Unit Administrator TypesPOST/research-common/api/v1/unit-administrator-types/
Example URI
POST /research-common/api/v1/unit-administrator-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"multiplesFlag": "(val)",
"defaultGroupFlag": "(val)",
"_primaryKey": "(val)"
}
]Delete Unit Administrator Types by KeyDELETE/research-common/api/v1/unit-administrator-types/(key)
Example URI
DELETE /research-common/api/v1/unit-administrator-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Unit Administrator TypesDELETE/research-common/api/v1/unit-administrator-types/
Example URI
DELETE /research-common/api/v1/unit-administrator-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Unit Administrator Types with MatchingDELETE/research-common/api/v1/unit-administrator-types/
Example URI
DELETE /research-common/api/v1/unit-administrator-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Unit Administrator Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- multiplesFlag
string(optional)Multiples Flag. Maximum length is 3.
- defaultGroupFlag
string(optional)Default Group Flag. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Unit Administrators ¶
Get Unit Administrators by KeyGET/research-common/api/v1/unit-administrators/(key)
Example URI
GET /research-common/api/v1/unit-administrators/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Get All Unit AdministratorsGET/research-common/api/v1/unit-administrators/
Example URI
GET /research-common/api/v1/unit-administrators/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Unit Administrators with FilteringGET/research-common/api/v1/unit-administrators/
Example URI
GET /research-common/api/v1/unit-administrators/
URI Parameters
- personId
string(optional)KcPerson Id. Maximum length is 40.
- unitAdministratorTypeCode
string(optional)Unit Administrator Type Code. Maximum length is 3.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Unit AdministratorsGET/research-common/api/v1/unit-administrators/
Example URI
GET /research-common/api/v1/unit-administrators/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"personId",
"unitAdministratorTypeCode",
"unitNumber"
],
"primaryKey": "personId:unitAdministratorTypeCode:unitNumber"
}Get Blueprint API specification for Unit AdministratorsGET/research-common/api/v1/unit-administrators/
Example URI
GET /research-common/api/v1/unit-administrators/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Unit Administrators.md"
transfer-encoding: chunkedUpdate Unit AdministratorsPUT/research-common/api/v1/unit-administrators/(key)
Example URI
PUT /research-common/api/v1/unit-administrators/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Unit AdministratorsPUT/research-common/api/v1/unit-administrators/
Example URI
PUT /research-common/api/v1/unit-administrators/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Unit AdministratorsPATCH/research-common/api/v1/unit-administrators/(key)
Example URI
PATCH /research-common/api/v1/unit-administrators/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Insert Unit AdministratorsPOST/research-common/api/v1/unit-administrators/
Example URI
POST /research-common/api/v1/unit-administrators/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Unit AdministratorsPOST/research-common/api/v1/unit-administrators/
Example URI
POST /research-common/api/v1/unit-administrators/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
},
{
"personId": "(val)",
"unitAdministratorTypeCode": "(val)",
"unitNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Unit Administrators by KeyDELETE/research-common/api/v1/unit-administrators/(key)
Example URI
DELETE /research-common/api/v1/unit-administrators/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Unit AdministratorsDELETE/research-common/api/v1/unit-administrators/
Example URI
DELETE /research-common/api/v1/unit-administrators/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Unit Administrators with MatchingDELETE/research-common/api/v1/unit-administrators/
Example URI
DELETE /research-common/api/v1/unit-administrators/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- personId
string(optional)KcPerson Id. Maximum length is 40.
- unitAdministratorTypeCode
string(optional)Unit Administrator Type Code. Maximum length is 3.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Unit Correspondents ¶
Get Unit Correspondents by KeyGET/research-common/api/v1/unit-correspondents/(key)
Example URI
GET /research-common/api/v1/unit-correspondents/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Unit CorrespondentsGET/research-common/api/v1/unit-correspondents/
Example URI
GET /research-common/api/v1/unit-correspondents/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Unit Correspondents with FilteringGET/research-common/api/v1/unit-correspondents/
Example URI
GET /research-common/api/v1/unit-correspondents/
URI Parameters
- correspondentId
string(optional)- unitNumber
string(optional)Unit Number. Maximum length is 8.
- correspondentTypeCode
string(optional)Correspondent Type Code. Maximum length is 22.
- personId
string(optional)This is a generic implementation of a ‘SystemId’ attribute. It should always be overriden on the label, shortLabel, summary, and description, as these are only generic placeholders. Maximum length is 40.
- nonEmployeeFlag
string(optional)Non Employee Flag. Maximum length is 1.
- description
string(optional)Description. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Unit CorrespondentsGET/research-common/api/v1/unit-correspondents/
Example URI
GET /research-common/api/v1/unit-correspondents/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"correspondentId",
"unitNumber",
"correspondentTypeCode",
"personId",
"nonEmployeeFlag",
"description"
],
"primaryKey": "correspondentId"
}Get Blueprint API specification for Unit CorrespondentsGET/research-common/api/v1/unit-correspondents/
Example URI
GET /research-common/api/v1/unit-correspondents/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Unit Correspondents.md"
transfer-encoding: chunkedUpdate Unit CorrespondentsPUT/research-common/api/v1/unit-correspondents/(key)
Example URI
PUT /research-common/api/v1/unit-correspondents/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Unit CorrespondentsPUT/research-common/api/v1/unit-correspondents/
Example URI
PUT /research-common/api/v1/unit-correspondents/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Unit CorrespondentsPATCH/research-common/api/v1/unit-correspondents/(key)
Example URI
PATCH /research-common/api/v1/unit-correspondents/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Unit CorrespondentsPOST/research-common/api/v1/unit-correspondents/
Example URI
POST /research-common/api/v1/unit-correspondents/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Unit CorrespondentsPOST/research-common/api/v1/unit-correspondents/
Example URI
POST /research-common/api/v1/unit-correspondents/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentId": "(val)",
"unitNumber": "(val)",
"correspondentTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Unit Correspondents by KeyDELETE/research-common/api/v1/unit-correspondents/(key)
Example URI
DELETE /research-common/api/v1/unit-correspondents/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Unit CorrespondentsDELETE/research-common/api/v1/unit-correspondents/
Example URI
DELETE /research-common/api/v1/unit-correspondents/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Unit Correspondents with MatchingDELETE/research-common/api/v1/unit-correspondents/
Example URI
DELETE /research-common/api/v1/unit-correspondents/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- correspondentId
string(optional)- unitNumber
string(optional)Unit Number. Maximum length is 8.
- correspondentTypeCode
string(optional)Correspondent Type Code. Maximum length is 22.
- personId
string(optional)This is a generic implementation of a ‘SystemId’ attribute. It should always be overriden on the label, shortLabel, summary, and description, as these are only generic placeholders. Maximum length is 40.
- nonEmployeeFlag
string(optional)Non Employee Flag. Maximum length is 1.
- description
string(optional)Description. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Unit Formulated Costs ¶
Get Unit Formulated Costs by KeyGET/research-common/api/v1/unit-formulated-costs/(key)
Example URI
GET /research-common/api/v1/unit-formulated-costs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
}Get All Unit Formulated CostsGET/research-common/api/v1/unit-formulated-costs/
Example URI
GET /research-common/api/v1/unit-formulated-costs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
},
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
}
]Get All Unit Formulated Costs with FilteringGET/research-common/api/v1/unit-formulated-costs/
Example URI
GET /research-common/api/v1/unit-formulated-costs/
URI Parameters
- unitFormulatedCostId
string(optional)- formulatedTypeCode
string(optional)Formulated Type. Maximum length is 50.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
- unitCost
string(optional)Unit Cost. Maximum length is 22.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
},
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Unit Formulated CostsGET/research-common/api/v1/unit-formulated-costs/
Example URI
GET /research-common/api/v1/unit-formulated-costs/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"unitFormulatedCostId",
"formulatedTypeCode",
"unitNumber",
"unitCost"
],
"primaryKey": "unitFormulatedCostId"
}Get Blueprint API specification for Unit Formulated CostsGET/research-common/api/v1/unit-formulated-costs/
Example URI
GET /research-common/api/v1/unit-formulated-costs/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Unit Formulated Costs.md"
transfer-encoding: chunkedUpdate Unit Formulated CostsPUT/research-common/api/v1/unit-formulated-costs/(key)
Example URI
PUT /research-common/api/v1/unit-formulated-costs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Unit Formulated CostsPUT/research-common/api/v1/unit-formulated-costs/
Example URI
PUT /research-common/api/v1/unit-formulated-costs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
},
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Unit Formulated CostsPATCH/research-common/api/v1/unit-formulated-costs/(key)
Example URI
PATCH /research-common/api/v1/unit-formulated-costs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
}Insert Unit Formulated CostsPOST/research-common/api/v1/unit-formulated-costs/
Example URI
POST /research-common/api/v1/unit-formulated-costs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Unit Formulated CostsPOST/research-common/api/v1/unit-formulated-costs/
Example URI
POST /research-common/api/v1/unit-formulated-costs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
},
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
},
{
"unitFormulatedCostId": "(val)",
"formulatedTypeCode": "(val)",
"unitNumber": "(val)",
"unitCost": "(val)",
"_primaryKey": "(val)"
}
]Delete Unit Formulated Costs by KeyDELETE/research-common/api/v1/unit-formulated-costs/(key)
Example URI
DELETE /research-common/api/v1/unit-formulated-costs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Unit Formulated CostsDELETE/research-common/api/v1/unit-formulated-costs/
Example URI
DELETE /research-common/api/v1/unit-formulated-costs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Unit Formulated Costs with MatchingDELETE/research-common/api/v1/unit-formulated-costs/
Example URI
DELETE /research-common/api/v1/unit-formulated-costs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- unitFormulatedCostId
string(optional)- formulatedTypeCode
string(optional)Formulated Type. Maximum length is 50.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
- unitCost
string(optional)Unit Cost. Maximum length is 22.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Units ¶
Get Units by KeyGET/research-common/api/v1/units/(key)
Example URI
GET /research-common/api/v1/units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All UnitsGET/research-common/api/v1/units/
Example URI
GET /research-common/api/v1/units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Units with FilteringGET/research-common/api/v1/units/
Example URI
GET /research-common/api/v1/units/
URI Parameters
- unitNumber
string(optional)Unit Number. Maximum length is 8.
- parentUnitNumber
string(optional)Parent Unit Number. Maximum length is 8.
- organizationId
string(optional)Organization Id. Maximum length is 8.
- unitName
string(optional)Unit Name. Maximum length is 60.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for UnitsGET/research-common/api/v1/units/
Example URI
GET /research-common/api/v1/units/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"unitNumber",
"parentUnitNumber",
"organizationId",
"unitName",
"active"
],
"primaryKey": "unitNumber"
}Get Blueprint API specification for UnitsGET/research-common/api/v1/units/
Example URI
GET /research-common/api/v1/units/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Units.md"
transfer-encoding: chunkedUpdate UnitsPUT/research-common/api/v1/units/(key)
Example URI
PUT /research-common/api/v1/units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple UnitsPUT/research-common/api/v1/units/
Example URI
PUT /research-common/api/v1/units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes UnitsPATCH/research-common/api/v1/units/(key)
Example URI
PATCH /research-common/api/v1/units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert UnitsPOST/research-common/api/v1/units/
Example URI
POST /research-common/api/v1/units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple UnitsPOST/research-common/api/v1/units/
Example URI
POST /research-common/api/v1/units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"unitNumber": "(val)",
"parentUnitNumber": "(val)",
"organizationId": "(val)",
"unitName": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Units by KeyDELETE/research-common/api/v1/units/(key)
Example URI
DELETE /research-common/api/v1/units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All UnitsDELETE/research-common/api/v1/units/
Example URI
DELETE /research-common/api/v1/units/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Units with MatchingDELETE/research-common/api/v1/units/
Example URI
DELETE /research-common/api/v1/units/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- unitNumber
string(optional)Unit Number. Maximum length is 8.
- parentUnitNumber
string(optional)Parent Unit Number. Maximum length is 8.
- organizationId
string(optional)Organization Id. Maximum length is 8.
- unitName
string(optional)Unit Name. Maximum length is 60.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Valid Calculation Types ¶
Get Valid Calculation Types by KeyGET/research-common/api/v1/valid-calculation-types/(key)
Example URI
GET /research-common/api/v1/valid-calculation-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Valid Calculation TypesGET/research-common/api/v1/valid-calculation-types/
Example URI
GET /research-common/api/v1/valid-calculation-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Valid Calculation Types with FilteringGET/research-common/api/v1/valid-calculation-types/
Example URI
GET /research-common/api/v1/valid-calculation-types/
URI Parameters
- calcTypeId
string(optional)Calc Type Id. Maximum length is 8.
- dependentSeqNumber
string(optional)Dependent Seq Number. Maximum length is 3.
- rateClassType
string(optional)Rate Class Type. Maximum length is 1.
- dependentRateClassType
string(optional)Dependent Rate Class Type. Maximum length is 1.
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Valid Calculation TypesGET/research-common/api/v1/valid-calculation-types/
Example URI
GET /research-common/api/v1/valid-calculation-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"calcTypeId",
"dependentSeqNumber",
"rateClassType",
"dependentRateClassType",
"rateClassCode",
"rateTypeCode"
],
"primaryKey": "calcTypeId:dependentSeqNumber:rateClassType"
}Get Blueprint API specification for Valid Calculation TypesGET/research-common/api/v1/valid-calculation-types/
Example URI
GET /research-common/api/v1/valid-calculation-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Calculation Types.md"
transfer-encoding: chunkedUpdate Valid Calculation TypesPUT/research-common/api/v1/valid-calculation-types/(key)
Example URI
PUT /research-common/api/v1/valid-calculation-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Valid Calculation TypesPUT/research-common/api/v1/valid-calculation-types/
Example URI
PUT /research-common/api/v1/valid-calculation-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Valid Calculation TypesPATCH/research-common/api/v1/valid-calculation-types/(key)
Example URI
PATCH /research-common/api/v1/valid-calculation-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Valid Calculation TypesPOST/research-common/api/v1/valid-calculation-types/
Example URI
POST /research-common/api/v1/valid-calculation-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Valid Calculation TypesPOST/research-common/api/v1/valid-calculation-types/
Example URI
POST /research-common/api/v1/valid-calculation-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"calcTypeId": "(val)",
"dependentSeqNumber": "(val)",
"rateClassType": "(val)",
"dependentRateClassType": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Valid Calculation Types by KeyDELETE/research-common/api/v1/valid-calculation-types/(key)
Example URI
DELETE /research-common/api/v1/valid-calculation-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Calculation TypesDELETE/research-common/api/v1/valid-calculation-types/
Example URI
DELETE /research-common/api/v1/valid-calculation-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Calculation Types with MatchingDELETE/research-common/api/v1/valid-calculation-types/
Example URI
DELETE /research-common/api/v1/valid-calculation-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- calcTypeId
string(optional)Calc Type Id. Maximum length is 8.
- dependentSeqNumber
string(optional)Dependent Seq Number. Maximum length is 3.
- rateClassType
string(optional)Rate Class Type. Maximum length is 1.
- dependentRateClassType
string(optional)Dependent Rate Class Type. Maximum length is 1.
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Valid Ce Job Codes ¶
Get Valid Ce Job Codes by KeyGET/research-common/api/v1/valid-ce-job-codes/(key)
Example URI
GET /research-common/api/v1/valid-ce-job-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
}Get All Valid Ce Job CodesGET/research-common/api/v1/valid-ce-job-codes/
Example URI
GET /research-common/api/v1/valid-ce-job-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Valid Ce Job Codes with FilteringGET/research-common/api/v1/valid-ce-job-codes/
Example URI
GET /research-common/api/v1/valid-ce-job-codes/
URI Parameters
- costElement
string(optional)Cost Element. Maximum length is 8.
- jobCode
string(optional)Job Code. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Valid Ce Job CodesGET/research-common/api/v1/valid-ce-job-codes/
Example URI
GET /research-common/api/v1/valid-ce-job-codes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"costElement",
"jobCode"
],
"primaryKey": "costElement:jobCode"
}Get Blueprint API specification for Valid Ce Job CodesGET/research-common/api/v1/valid-ce-job-codes/
Example URI
GET /research-common/api/v1/valid-ce-job-codes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Ce Job Codes.md"
transfer-encoding: chunkedUpdate Valid Ce Job CodesPUT/research-common/api/v1/valid-ce-job-codes/(key)
Example URI
PUT /research-common/api/v1/valid-ce-job-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Valid Ce Job CodesPUT/research-common/api/v1/valid-ce-job-codes/
Example URI
PUT /research-common/api/v1/valid-ce-job-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Valid Ce Job CodesPATCH/research-common/api/v1/valid-ce-job-codes/(key)
Example URI
PATCH /research-common/api/v1/valid-ce-job-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
}Insert Valid Ce Job CodesPOST/research-common/api/v1/valid-ce-job-codes/
Example URI
POST /research-common/api/v1/valid-ce-job-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Valid Ce Job CodesPOST/research-common/api/v1/valid-ce-job-codes/
Example URI
POST /research-common/api/v1/valid-ce-job-codes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"jobCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Valid Ce Job Codes by KeyDELETE/research-common/api/v1/valid-ce-job-codes/(key)
Example URI
DELETE /research-common/api/v1/valid-ce-job-codes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Ce Job CodesDELETE/research-common/api/v1/valid-ce-job-codes/
Example URI
DELETE /research-common/api/v1/valid-ce-job-codes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Ce Job Codes with MatchingDELETE/research-common/api/v1/valid-ce-job-codes/
Example URI
DELETE /research-common/api/v1/valid-ce-job-codes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- costElement
string(optional)Cost Element. Maximum length is 8.
- jobCode
string(optional)Job Code. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Valid Ce Rate Types ¶
Get Valid Ce Rate Types by KeyGET/research-common/api/v1/valid-ce-rate-types/(key)
Example URI
GET /research-common/api/v1/valid-ce-rate-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Valid Ce Rate TypesGET/research-common/api/v1/valid-ce-rate-types/
Example URI
GET /research-common/api/v1/valid-ce-rate-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Valid Ce Rate Types with FilteringGET/research-common/api/v1/valid-ce-rate-types/
Example URI
GET /research-common/api/v1/valid-ce-rate-types/
URI Parameters
- costElement
string(optional)Cost Element. Maximum length is 8.
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Valid Ce Rate TypesGET/research-common/api/v1/valid-ce-rate-types/
Example URI
GET /research-common/api/v1/valid-ce-rate-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"costElement",
"rateClassCode",
"rateTypeCode",
"active"
],
"primaryKey": "costElement:rateClassCode:rateTypeCode"
}Get Blueprint API specification for Valid Ce Rate TypesGET/research-common/api/v1/valid-ce-rate-types/
Example URI
GET /research-common/api/v1/valid-ce-rate-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Ce Rate Types.md"
transfer-encoding: chunkedUpdate Valid Ce Rate TypesPUT/research-common/api/v1/valid-ce-rate-types/(key)
Example URI
PUT /research-common/api/v1/valid-ce-rate-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Valid Ce Rate TypesPUT/research-common/api/v1/valid-ce-rate-types/
Example URI
PUT /research-common/api/v1/valid-ce-rate-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Valid Ce Rate TypesPATCH/research-common/api/v1/valid-ce-rate-types/(key)
Example URI
PATCH /research-common/api/v1/valid-ce-rate-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Valid Ce Rate TypesPOST/research-common/api/v1/valid-ce-rate-types/
Example URI
POST /research-common/api/v1/valid-ce-rate-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Valid Ce Rate TypesPOST/research-common/api/v1/valid-ce-rate-types/
Example URI
POST /research-common/api/v1/valid-ce-rate-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"costElement": "(val)",
"rateClassCode": "(val)",
"rateTypeCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Valid Ce Rate Types by KeyDELETE/research-common/api/v1/valid-ce-rate-types/(key)
Example URI
DELETE /research-common/api/v1/valid-ce-rate-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Ce Rate TypesDELETE/research-common/api/v1/valid-ce-rate-types/
Example URI
DELETE /research-common/api/v1/valid-ce-rate-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Ce Rate Types with MatchingDELETE/research-common/api/v1/valid-ce-rate-types/
Example URI
DELETE /research-common/api/v1/valid-ce-rate-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- costElement
string(optional)Cost Element. Maximum length is 8.
- rateClassCode
string(optional)Rate Class Code. Maximum length is 3.
- rateTypeCode
string(optional)Rate Type Code. Maximum length is 3.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Valid Special Review Approvals ¶
Get Valid Special Review Approvals by KeyGET/research-common/api/v1/valid-special-review-approvals/(key)
Example URI
GET /research-common/api/v1/valid-special-review-approvals/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
}Get All Valid Special Review ApprovalsGET/research-common/api/v1/valid-special-review-approvals/
Example URI
GET /research-common/api/v1/valid-special-review-approvals/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
},
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
}
]Get All Valid Special Review Approvals with FilteringGET/research-common/api/v1/valid-special-review-approvals/
Example URI
GET /research-common/api/v1/valid-special-review-approvals/
URI Parameters
- validSpecialReviewApprovalId
string(optional)Valid Special Review Approval Id. Maximum length is 22.
- specialReviewTypeCode
string(optional)Special Review Type Code. Maximum length is 3.
- approvalTypeCode
string(optional)Special Review Approval Type Code. Maximum length is 3.
- applicationDateFlag
string(optional)Validate Application Date. Maximum length is 1.
- approvalDateFlag
string(optional)Validate Approval Date. Maximum length is 1.
- exemptNumberFlag
string(optional)Validate Exempt Number is required or not. Maximum length is 1.
- protocolNumberFlag
string(optional)Validate Protocol Number. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
},
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Valid Special Review ApprovalsGET/research-common/api/v1/valid-special-review-approvals/
Example URI
GET /research-common/api/v1/valid-special-review-approvals/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"validSpecialReviewApprovalId",
"specialReviewTypeCode",
"approvalTypeCode",
"applicationDateFlag",
"approvalDateFlag",
"exemptNumberFlag",
"protocolNumberFlag"
],
"primaryKey": "validSpecialReviewApprovalId"
}Get Blueprint API specification for Valid Special Review ApprovalsGET/research-common/api/v1/valid-special-review-approvals/
Example URI
GET /research-common/api/v1/valid-special-review-approvals/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Special Review Approvals.md"
transfer-encoding: chunkedUpdate Valid Special Review ApprovalsPUT/research-common/api/v1/valid-special-review-approvals/(key)
Example URI
PUT /research-common/api/v1/valid-special-review-approvals/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Valid Special Review ApprovalsPUT/research-common/api/v1/valid-special-review-approvals/
Example URI
PUT /research-common/api/v1/valid-special-review-approvals/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
},
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Valid Special Review ApprovalsPATCH/research-common/api/v1/valid-special-review-approvals/(key)
Example URI
PATCH /research-common/api/v1/valid-special-review-approvals/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
}Insert Valid Special Review ApprovalsPOST/research-common/api/v1/valid-special-review-approvals/
Example URI
POST /research-common/api/v1/valid-special-review-approvals/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Valid Special Review ApprovalsPOST/research-common/api/v1/valid-special-review-approvals/
Example URI
POST /research-common/api/v1/valid-special-review-approvals/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
},
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
},
{
"validSpecialReviewApprovalId": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"applicationDateFlag": "(val)",
"approvalDateFlag": "(val)",
"exemptNumberFlag": "(val)",
"protocolNumberFlag": "(val)",
"_primaryKey": "(val)"
}
]Delete Valid Special Review Approvals by KeyDELETE/research-common/api/v1/valid-special-review-approvals/(key)
Example URI
DELETE /research-common/api/v1/valid-special-review-approvals/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Special Review ApprovalsDELETE/research-common/api/v1/valid-special-review-approvals/
Example URI
DELETE /research-common/api/v1/valid-special-review-approvals/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Special Review Approvals with MatchingDELETE/research-common/api/v1/valid-special-review-approvals/
Example URI
DELETE /research-common/api/v1/valid-special-review-approvals/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- validSpecialReviewApprovalId
string(optional)Valid Special Review Approval Id. Maximum length is 22.
- specialReviewTypeCode
string(optional)Special Review Type Code. Maximum length is 3.
- approvalTypeCode
string(optional)Special Review Approval Type Code. Maximum length is 3.
- applicationDateFlag
string(optional)Validate Application Date. Maximum length is 1.
- approvalDateFlag
string(optional)Validate Approval Date. Maximum length is 1.
- exemptNumberFlag
string(optional)Validate Exempt Number is required or not. Maximum length is 1.
- protocolNumberFlag
string(optional)Validate Protocol Number. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Version Histories ¶
Get Version Histories by KeyGET/research-common/api/v1/version-histories/(key)
Example URI
GET /research-common/api/v1/version-histories/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}Get All Version HistoriesGET/research-common/api/v1/version-histories/
Example URI
GET /research-common/api/v1/version-histories/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
},
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}
]Get All Version Histories with FilteringGET/research-common/api/v1/version-histories/
Example URI
GET /research-common/api/v1/version-histories/
URI Parameters
- versionHistoryId
string(optional)- sequenceOwnerClassName
string(optional)- sequenceOwnerVersionNameField
string(optional)- sequenceOwnerVersionNameValue
string(optional)- sequenceOwnerSequenceNumber
string(optional)- statusForOjb
string(optional)- userId
string(optional)- versionDate
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
},
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Version HistoriesGET/research-common/api/v1/version-histories/
Example URI
GET /research-common/api/v1/version-histories/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"versionHistoryId",
"sequenceOwnerClassName",
"sequenceOwnerVersionNameField",
"sequenceOwnerVersionNameValue",
"sequenceOwnerSequenceNumber",
"statusForOjb",
"userId",
"versionDate"
],
"primaryKey": "versionHistoryId"
}Get Blueprint API specification for Version HistoriesGET/research-common/api/v1/version-histories/
Example URI
GET /research-common/api/v1/version-histories/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Version Histories.md"
transfer-encoding: chunkedUpdate Version HistoriesPUT/research-common/api/v1/version-histories/(key)
Example URI
PUT /research-common/api/v1/version-histories/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Version HistoriesPUT/research-common/api/v1/version-histories/
Example URI
PUT /research-common/api/v1/version-histories/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
},
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Version HistoriesPATCH/research-common/api/v1/version-histories/(key)
Example URI
PATCH /research-common/api/v1/version-histories/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}Insert Version HistoriesPOST/research-common/api/v1/version-histories/
Example URI
POST /research-common/api/v1/version-histories/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Version HistoriesPOST/research-common/api/v1/version-histories/
Example URI
POST /research-common/api/v1/version-histories/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
},
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
},
{
"versionHistoryId": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}
]Delete Version Histories by KeyDELETE/research-common/api/v1/version-histories/(key)
Example URI
DELETE /research-common/api/v1/version-histories/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Version HistoriesDELETE/research-common/api/v1/version-histories/
Example URI
DELETE /research-common/api/v1/version-histories/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Version Histories with MatchingDELETE/research-common/api/v1/version-histories/
Example URI
DELETE /research-common/api/v1/version-histories/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- versionHistoryId
string(optional)- sequenceOwnerClassName
string(optional)- sequenceOwnerVersionNameField
string(optional)- sequenceOwnerVersionNameValue
string(optional)- sequenceOwnerSequenceNumber
string(optional)- statusForOjb
string(optional)- userId
string(optional)- versionDate
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Version History Searches ¶
Get Version History Searches by KeyGET/research-common/api/v1/version-history-searches/(key)
Example URI
GET /research-common/api/v1/version-history-searches/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}Get All Version History SearchesGET/research-common/api/v1/version-history-searches/
Example URI
GET /research-common/api/v1/version-history-searches/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
},
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}
]Get All Version History Searches with FilteringGET/research-common/api/v1/version-history-searches/
Example URI
GET /research-common/api/v1/version-history-searches/
URI Parameters
- sequenceOwnerVersionNameValue
string(optional)- sequenceOwnerSequenceNumber
string(optional)- sequenceOwnerClassName
string(optional)- sequenceOwnerVersionNameField
string(optional)- statusForOjb
string(optional)- userId
string(optional)- versionDate
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
},
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Version History SearchesGET/research-common/api/v1/version-history-searches/
Example URI
GET /research-common/api/v1/version-history-searches/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"sequenceOwnerVersionNameValue",
"sequenceOwnerSequenceNumber",
"sequenceOwnerClassName",
"sequenceOwnerVersionNameField",
"statusForOjb",
"userId",
"versionDate"
],
"primaryKey": "sequenceOwnerSequenceNumber:sequenceOwnerVersionNameValue"
}Get Blueprint API specification for Version History SearchesGET/research-common/api/v1/version-history-searches/
Example URI
GET /research-common/api/v1/version-history-searches/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Version History Searches.md"
transfer-encoding: chunkedUpdate Version History SearchesPUT/research-common/api/v1/version-history-searches/(key)
Example URI
PUT /research-common/api/v1/version-history-searches/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Version History SearchesPUT/research-common/api/v1/version-history-searches/
Example URI
PUT /research-common/api/v1/version-history-searches/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
},
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Version History SearchesPATCH/research-common/api/v1/version-history-searches/(key)
Example URI
PATCH /research-common/api/v1/version-history-searches/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}Insert Version History SearchesPOST/research-common/api/v1/version-history-searches/
Example URI
POST /research-common/api/v1/version-history-searches/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Version History SearchesPOST/research-common/api/v1/version-history-searches/
Example URI
POST /research-common/api/v1/version-history-searches/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
},
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
},
{
"sequenceOwnerVersionNameValue": "(val)",
"sequenceOwnerSequenceNumber": "(val)",
"sequenceOwnerClassName": "(val)",
"sequenceOwnerVersionNameField": "(val)",
"statusForOjb": "(val)",
"userId": "(val)",
"versionDate": "(val)",
"_primaryKey": "(val)"
}
]Delete Version History Searches by KeyDELETE/research-common/api/v1/version-history-searches/(key)
Example URI
DELETE /research-common/api/v1/version-history-searches/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Version History SearchesDELETE/research-common/api/v1/version-history-searches/
Example URI
DELETE /research-common/api/v1/version-history-searches/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Version History Searches with MatchingDELETE/research-common/api/v1/version-history-searches/
Example URI
DELETE /research-common/api/v1/version-history-searches/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- sequenceOwnerVersionNameValue
string(optional)- sequenceOwnerSequenceNumber
string(optional)- sequenceOwnerClassName
string(optional)- sequenceOwnerVersionNameField
string(optional)- statusForOjb
string(optional)- userId
string(optional)- versionDate
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Ynq Explanation Types ¶
Get Ynq Explanation Types by KeyGET/research-common/api/v1/ynq-explanation-types/(key)
Example URI
GET /research-common/api/v1/ynq-explanation-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Ynq Explanation TypesGET/research-common/api/v1/ynq-explanation-types/
Example URI
GET /research-common/api/v1/ynq-explanation-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Ynq Explanation Types with FilteringGET/research-common/api/v1/ynq-explanation-types/
Example URI
GET /research-common/api/v1/ynq-explanation-types/
URI Parameters
- explanationType
string(optional)Explanation Type. Maximum length is 1.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Ynq Explanation TypesGET/research-common/api/v1/ynq-explanation-types/
Example URI
GET /research-common/api/v1/ynq-explanation-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"explanationType",
"description"
],
"primaryKey": "explanationType"
}Get Blueprint API specification for Ynq Explanation TypesGET/research-common/api/v1/ynq-explanation-types/
Example URI
GET /research-common/api/v1/ynq-explanation-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Ynq Explanation Types.md"
transfer-encoding: chunkedUpdate Ynq Explanation TypesPUT/research-common/api/v1/ynq-explanation-types/(key)
Example URI
PUT /research-common/api/v1/ynq-explanation-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Ynq Explanation TypesPUT/research-common/api/v1/ynq-explanation-types/
Example URI
PUT /research-common/api/v1/ynq-explanation-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Ynq Explanation TypesPATCH/research-common/api/v1/ynq-explanation-types/(key)
Example URI
PATCH /research-common/api/v1/ynq-explanation-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Ynq Explanation TypesPOST/research-common/api/v1/ynq-explanation-types/
Example URI
POST /research-common/api/v1/ynq-explanation-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Ynq Explanation TypesPOST/research-common/api/v1/ynq-explanation-types/
Example URI
POST /research-common/api/v1/ynq-explanation-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"explanationType": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Ynq Explanation Types by KeyDELETE/research-common/api/v1/ynq-explanation-types/(key)
Example URI
DELETE /research-common/api/v1/ynq-explanation-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Ynq Explanation TypesDELETE/research-common/api/v1/ynq-explanation-types/
Example URI
DELETE /research-common/api/v1/ynq-explanation-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Ynq Explanation Types with MatchingDELETE/research-common/api/v1/ynq-explanation-types/
Example URI
DELETE /research-common/api/v1/ynq-explanation-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- explanationType
string(optional)Explanation Type. Maximum length is 1.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Ynq Explanations ¶
Get Ynq Explanations by KeyGET/research-common/api/v1/ynq-explanations/(key)
Example URI
GET /research-common/api/v1/ynq-explanations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}Get All Ynq ExplanationsGET/research-common/api/v1/ynq-explanations/
Example URI
GET /research-common/api/v1/ynq-explanations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
},
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}
]Get All Ynq Explanations with FilteringGET/research-common/api/v1/ynq-explanations/
Example URI
GET /research-common/api/v1/ynq-explanations/
URI Parameters
- explanationType
string(optional)Explanation Type. Maximum length is 1.
- questionId
string(optional)Question Id. Maximum length is 4.
- explanation
string(optional)Explanation. Maximum length is 400.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
},
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Ynq ExplanationsGET/research-common/api/v1/ynq-explanations/
Example URI
GET /research-common/api/v1/ynq-explanations/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"explanationType",
"questionId",
"explanation"
],
"primaryKey": "explanationType:questionId"
}Get Blueprint API specification for Ynq ExplanationsGET/research-common/api/v1/ynq-explanations/
Example URI
GET /research-common/api/v1/ynq-explanations/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Ynq Explanations.md"
transfer-encoding: chunkedUpdate Ynq ExplanationsPUT/research-common/api/v1/ynq-explanations/(key)
Example URI
PUT /research-common/api/v1/ynq-explanations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Ynq ExplanationsPUT/research-common/api/v1/ynq-explanations/
Example URI
PUT /research-common/api/v1/ynq-explanations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
},
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Ynq ExplanationsPATCH/research-common/api/v1/ynq-explanations/(key)
Example URI
PATCH /research-common/api/v1/ynq-explanations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}Insert Ynq ExplanationsPOST/research-common/api/v1/ynq-explanations/
Example URI
POST /research-common/api/v1/ynq-explanations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Ynq ExplanationsPOST/research-common/api/v1/ynq-explanations/
Example URI
POST /research-common/api/v1/ynq-explanations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
},
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
},
{
"explanationType": "(val)",
"questionId": "(val)",
"explanation": "(val)",
"_primaryKey": "(val)"
}
]Delete Ynq Explanations by KeyDELETE/research-common/api/v1/ynq-explanations/(key)
Example URI
DELETE /research-common/api/v1/ynq-explanations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Ynq ExplanationsDELETE/research-common/api/v1/ynq-explanations/
Example URI
DELETE /research-common/api/v1/ynq-explanations/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Ynq Explanations with MatchingDELETE/research-common/api/v1/ynq-explanations/
Example URI
DELETE /research-common/api/v1/ynq-explanations/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- explanationType
string(optional)Explanation Type. Maximum length is 1.
- questionId
string(optional)Question Id. Maximum length is 4.
- explanation
string(optional)Explanation. Maximum length is 400.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Ynqs ¶
Get Ynqs by KeyGET/research-common/api/v1/ynqs/(key)
Example URI
GET /research-common/api/v1/ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Get All YnqsGET/research-common/api/v1/ynqs/
Example URI
GET /research-common/api/v1/ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Get All Ynqs with FilteringGET/research-common/api/v1/ynqs/
Example URI
GET /research-common/api/v1/ynqs/
URI Parameters
- questionId
string(optional)Question Id. Maximum length is 4.
- dateRequiredFor
string(optional)Date Required For. Maximum length is 3.
- description
string(optional)Description. Maximum length is 400.
- effectiveDate
string(optional)Effective Date. Maximum length is 21.
- explanationRequiredFor
string(optional)Explanation Required For. Maximum length is 3.
- groupName
string(optional)Group Name. Maximum length is 150.
- noOfAnswers
string(optional)No Of Answers. Maximum length is 2.
- questionType
string(optional)Question Type. Maximum length is 1.
- status
string(optional)Status. Maximum length is 1.
- sortId
string(optional)Sort ID. Maximum length is 12.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for YnqsGET/research-common/api/v1/ynqs/
Example URI
GET /research-common/api/v1/ynqs/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"questionId",
"dateRequiredFor",
"description",
"effectiveDate",
"explanationRequiredFor",
"groupName",
"noOfAnswers",
"questionType",
"status",
"sortId"
],
"primaryKey": "questionId"
}Get Blueprint API specification for YnqsGET/research-common/api/v1/ynqs/
Example URI
GET /research-common/api/v1/ynqs/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Ynqs.md"
transfer-encoding: chunkedUpdate YnqsPUT/research-common/api/v1/ynqs/(key)
Example URI
PUT /research-common/api/v1/ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple YnqsPUT/research-common/api/v1/ynqs/
Example URI
PUT /research-common/api/v1/ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes YnqsPATCH/research-common/api/v1/ynqs/(key)
Example URI
PATCH /research-common/api/v1/ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Insert YnqsPOST/research-common/api/v1/ynqs/
Example URI
POST /research-common/api/v1/ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple YnqsPOST/research-common/api/v1/ynqs/
Example URI
POST /research-common/api/v1/ynqs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
},
{
"questionId": "(val)",
"dateRequiredFor": "(val)",
"description": "(val)",
"effectiveDate": "(val)",
"explanationRequiredFor": "(val)",
"groupName": "(val)",
"noOfAnswers": "(val)",
"questionType": "(val)",
"status": "(val)",
"sortId": "(val)",
"_primaryKey": "(val)"
}
]Delete Ynqs by KeyDELETE/research-common/api/v1/ynqs/(key)
Example URI
DELETE /research-common/api/v1/ynqs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All YnqsDELETE/research-common/api/v1/ynqs/
Example URI
DELETE /research-common/api/v1/ynqs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Ynqs with MatchingDELETE/research-common/api/v1/ynqs/
Example URI
DELETE /research-common/api/v1/ynqs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- questionId
string(optional)Question Id. Maximum length is 4.
- dateRequiredFor
string(optional)Date Required For. Maximum length is 3.
- description
string(optional)Description. Maximum length is 400.
- effectiveDate
string(optional)Effective Date. Maximum length is 21.
- explanationRequiredFor
string(optional)Explanation Required For. Maximum length is 3.
- groupName
string(optional)Group Name. Maximum length is 150.
- noOfAnswers
string(optional)No Of Answers. Maximum length is 2.
- questionType
string(optional)Question Type. Maximum length is 1.
- status
string(optional)Status. Maximum length is 1.
- sortId
string(optional)Sort ID. Maximum length is 12.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204