POST //v1/requests
create a request

Examples

POST /v1/requests?opportunityId=2&requestType=Renewal&requestNumber=STA140004
{
    "message": null,
    "result": {
        "rules": {
            "requestId": 1188808,
            "allowedOperations": [
                "Edit",
                "Delete"
            ],
            "allowedActions": [
            ],
            "allowedActionsRes": [
            ],
            "existingActions": [
                {
                    "actionId": 66152,
                    "actionType": "Renewal",
                    "allowedOperations": [
                        "Edit",
                        "Delete"
                    ],
                    "reviewsViewable": false
                }
            ]
        },
        "requestId": 1188808,
        "requestType": "Renewal",
        "requestStatus": "Incomplete",
        "requestNumber": "STA140004",
        "opportunityId": 2,
        "isDeleted": false,
        "title": null,
        "shortTitle": null,
        "abstract": null,
        "submitDate": null,
        "isSupportedByGrants": null,
        "actions": [
            {
                "actionId": 66152,
                "actionType": "Renewal",
                "actionStatus": "Incomplete",
                "finalReviews": [
                ],
                "isDeleted": false,
                "userComments": null,
                "adminComments": null,
                "collaborators": null,
                "finalReview": "",
                "states": [
                ],
                "resources": [
                ],
                "documents": [
                ],
                "allocationDates": [
                ],
                "opportunityAttributes": [
                ],
                "resourceAttributes": [
                ]
            }
        ],
        "roles": [
            {
                "person": {
                    "username": "mshapiro",
                    "firstName": "Michael",
                    "middleName": null,
                    "lastName": "Shapiro",
                    "email": "shapiro2@illinois.edu",
                    "phone": "217-244-1514",
                    "organization": "University of Illinois at Urbana-Champaign",
                    "academicStatus": "Center Researcher Staff",
                    "residenceCountry": "United States",
                    "isReconciled": true
                },
                "roles": [
                    {
                        "roleId": 92628,
                        "role": "Allocation Manager",
                        "roleTypeId": 3,
                        "beginDate": "2019-01-18",
                        "endDate": null,
                        "isAccountToBeCreated": false
                    }
                ]
            }
        ],
        "fos": [
        ],
        "grants": [
        ],
        "conflicts": [
        ],
        "publications": [
        ]
    }
}

Params

Param name Description
opportunityId
optional

Validations:

  • Must be a Integer
requestType
optional

Validations:

  • Must be a String
requestNumber
optional

Validations:

  • Must be a String
grantTypeId
optional

Validations:

  • Must be a Integer

Returns

Code: 200

Description:

OK

Param name Description
rules
required

Validations:

  • Must be a Hash
rules[requestId]
required

Validations:

  • Must be a Integer
rules[allowedOperations]
required

Validations:

  • Must be an array of String
rules[allowedActions]
required

Validations:

  • Must be an array of String
rules[allowedActionsRes]
required

Validations:

  • Must be an Array of nested elements
rules[allowedActionsRes][actionType]
required

Validations:

  • Must be a String
rules[allowedActionsRes][availableResourceIds]
required

Validations:

  • Must be an array of Integer
rules[allowedActionsRes][existingActions]
required

Validations:

  • Must be an Array of nested elements
rules[allowedActionsRes][existingActions][actionId]
required

Validations:

  • Must be a Integer
rules[allowedActionsRes][existingActions][actionType]
required

Validations:

  • Must be a String
rules[allowedActionsRes][existingActions][allowedOperations]
required

Validations:

  • Must be an array of String
rules[allowedActionsRes][existingActions][reviewsViewable]
required

Validations:

  • Must be one of: true, false.
requestId
required

Validations:

  • Must be a Integer
requestType
required

Validations:

  • Must be a String
requestStatus
required

Validations:

  • Must be a String
requestNumber
required

Validations:

  • Must be a String
opportunityId
required

Validations:

  • Must be a Integer
isDeleted
required

Validations:

  • Must be one of: true, false.
title
required

Validations:

  • Must be a String
shortTitle
required

Validations:

  • Must be one of: String, null.
abstract
required

Validations:

  • Must be a String
submitDate
required

Validations:

  • Must be a DateTime
isSupportedByGrants
required

Validations:

  • Must be one of: true, false.
grantTypeId
required

Validations:

  • Must be a Integer
displayGrantType
required

Validations:

  • Must be a String
actions
required

Validations:

  • Must be an Array of nested elements
actions[actionId]
required

Validations:

  • Must be a Integer
actions[actionType]
required

Validations:

  • Must be a String
actions[actionStatus]
required

Validations:

  • Must be a String
actions[isDeleted]
required

Validations:

  • Must be one of: true, false.
actions[userComments]
required

Validations:

  • Must be a String
actions[adminComments]
required

Validations:

  • Must be a String
actions[collaborators]
required

Validations:

  • Must be a String
actions[states]
required

Validations:

  • Must be an array of String
actions[resources]
required

Validations:

  • Must be an Array of nested elements
actions[resources][resourceId]
required

Validations:

  • Must be a Integer
actions[resources][resourceName]
required

Validations:

  • Must be a String
actions[resources][displayResourceName]
required

Validations:

  • Must be a String
actions[resources][resourceType]
required

Validations:

  • Must be a String
actions[resources][resourceActualType]
required

Validations:

  • Must be a String
actions[resources][resourceUnits]
required

Validations:

  • Must be a String
actions[resources][resourceUnitType]
required

Validations:

  • Must be a String
actions[resources][amount]
required

Validations:

  • Must be a String
actions[resources][comments]
required

Validations:

  • Must be a String
actions[resources][type]
required

Validations:

  • Must be a String
actions[documents]
required

Validations:

  • Must be an Array of nested elements
actions[documents][documentId]
required

Validations:

  • Must be a Integer
actions[documents][documentType]
required

Validations:

  • Must be a String
actions[documents][title]
required

Validations:

  • Must be a String
actions[documents][filename]
required

Validations:

  • Must be a String
actions[documents][size]
required

Validations:

  • Must be a Integer
actions[allocationDates]
required

Validations:

  • Must be an array of DateTime
actions[opportunityAttributes]
required

Validations:

  • Must be an Array of nested elements
actions[opportunityAttributes][opportunityAttributeId]
required

Validations:

  • Must be a Integer
actions[opportunityAttributes][attributeValue]
required

Validations:

  • Must be a String
actions[resourceAttributes]
required

Validations:

  • Must be an Array of nested elements
actions[resourceAttributes][resourceAttributeId]
required

Validations:

  • Must be a Integer
actions[resourceAttributes][attributeValue]
required

Validations:

  • Must be a String
actions[resourceAttributes][resourceId]
required

Validations:

  • Must be a Integer
roles
required

Validations:

  • Must be an Array of nested elements
roles[firstName]
optional

Validations:

  • Must be a String
roles[middleName]
optional

Validations:

  • Must be a String
roles[lastName]
optional

Validations:

  • Must be a String
roles[email]
optional

Validations:

  • Must be a String
roles[phone]
optional

Validations:

  • Must be a String
roles[organization]
optional

Validations:

  • Must be a String
roles[academicStatus]
optional

Validations:

  • Must be a String
roles[residenceCountry]
optional

Validations:

  • Must be a String
roles[isReconciled]
optional

true|false (default true) – only used when creating the user in XRAS

Validations:

  • Must be a String
roles[roles]
required

Validations:

  • Must be an Array of nested elements
roles[roles][roleId]
required

Validations:

  • Must be a Integer
roles[roles][role]
required

Validations:

  • Must be a String
roles[roles][roleTypeId]
required

Validations:

  • Must be a Integer
roles[roles][beginDate]
required

Validations:

  • Must be a DateTime
roles[roles][endDate]
required

Validations:

  • Must be a DateTime
roles[roles][isAccountToBeCreated]
required

Validations:

  • Must be one of: true, false.
fos
required

Validations:

  • Must be an Array of nested elements
fos[fosTypeId]
required

Validations:

  • Must be a Integer
fos[fosNum]
required

Validations:

  • Must be a Integer
fos[isPrimary]
required

Validations:

  • Must be one of: true, false.
keywords
required

Validations:

  • Must be a String
grants
required

Validations:

  • Must be an Array of nested elements
grants[grantId]
required

Validations:

  • Must be a Integer
grants[fundingAgencyId]
required

Validations:

  • Must be a Integer
grants[grantNumber]
required

Validations:

  • Must be a String
grants[piName]
required

Validations:

  • Must be a String
grants[title]
required

Validations:

  • Must be a String
grants[beginDate]
required

Validations:

  • Must be a DateTime
grants[endDate]
required

Validations:

  • Must be a DateTime
grants[awardedAmount]
required

Validations:

  • Must be a DateTime
grants[awardedUnits]
required

Validations:

  • Must be a String
grants[percentageAward]
required

Validations:

  • Must be a String
grants[programOfficerName]
required

Validations:

  • Must be a String
grants[programOfficerEmail]
required

Validations:

  • Must be a String
grants[isPending]
required

Validations:

  • Must be one of: true, false.
grants[subAwardNumber]
required

Validations:

  • Must be a String
grants[comments]
required

Validations:

  • Must be a String
grants[primaryFosTypeId]
required

Validations:

  • Must be a Integer
conflicts
required

Validations:

  • Must be an Array of nested elements
conflicts[conflictId]
required

Validations:

  • Must be a Integer
conflicts[conflictType]
required

Validations:

  • Must be a String
conflicts[conflictPerson]
required

Validations:

  • Must be a String
publications
required

Validations:

  • Must be an Array of nested elements
publications[publicationId]
required

Validations:

  • Must be a Integer
publications[publication]
required

Validations:

  • Must be a String