Reports

>>>

GET //v1/reports/fos/<fosId>
get requests for specified field of science

Examples

GET /v1/reports/fos/<fosId>
{
    "message": null,
    "result": [
        {
            "actionId": 41095,
            "actionType": "New",
            "beginDate": "2017-02-06",
            "endDate": "2021-08-31",
            "requestID": "000000",
            "requestTitle": "...",
            "requestNumber": "AAA123456",
            "pi": "lastName, firstName",
            "piInstitution": "InstitutionName",
            "piUsername": "username",
            "fos": "Computer and Information Science and Engineering",
            "opportunity": "Startup",
            "abstract": "Abstract...",
            "resources": [
                {
                    "resourceId": 530189,
                    "resourceName": "PSC Regular Memory (Bridges)",
                    "resourceType": "Compute",
                    "resourceUnits": "SUs",
                    "resourceUnitType": "Service Units",
                    "amount": "100.0",
                    "comments": "...",
                },
                ...
            ]
        },
        ...
    ]
}

Params

Param name Description
fosId
required

The Field of Science ID

Validations:

  • Must be a Integer

Returns

Code: 200

Description:

OK

Param name Description
actionId
required

Validations:

  • Must be a Integer
actionType
required

Validations:

  • Must be a String
beginDate
required

Validations:

  • Must be a DateTime
endDate
required

Validations:

  • Must be a DateTime
requestId
required

Validations:

  • Must be a Integer
requestTitle
required

Validations:

  • Must be a String
requestNumber
required

Validations:

  • Must be a String
pi
required

Validations:

  • Must be a String
piInstitution
required

Validations:

  • Must be a String
piUsername
required

Validations:

  • Must be a String
fos
required

Validations:

  • Must be a String
opportunity
required

Validations:

  • Must be a String
abstract
required

Validations:

  • Must be a String
resources
required

Validations:

  • Must be a Hash
resources[resourceId]
required

Validations:

  • Must be a Integer
resources[resourceName]
required

Validations:

  • Must be a String
resources[resourceType]
required

Validations:

  • Must be a String
resources[resourceUnits]
required

Validations:

  • Must be a String
resources[amount]
required

Validations:

  • Must be a Float
resources[comments]
required , nil allowed

Validations:

  • Must be a String
requestedResources
required

Validations:

  • Must be a Hash
requestedResources[resourceId]
required

Validations:

  • Must be a Integer
requestedResources[resourceName]
required

Validations:

  • Must be a String
requestedResources[resourceType]
required

Validations:

  • Must be a String
requestedResources[resourceUnits]
required

Validations:

  • Must be a String
requestedResources[amount]
required

Validations:

  • Must be a Float
requestedResources[comments]
required , nil allowed

Validations:

  • Must be a String
>>>

GET //v1/reports/allocations
get all allocations or allocations filtered by status

Examples

GET /v1/reports/allocations
or
GET /v1/reports/allocations?status=<active|inactive>
{
    "message": null,
    "result": [
        {
            "actionId": 41095,
            "actionType": "New",
            "beginDate": "2017-02-06",
            "endDate": "2021-08-31",
            "requestId": "000000",
            "requestTitle": "...",
            "requestNumber": "AAA123456",
            "pi": "lastName, firstName",
            "piInstitution": "InstitutionName",
            "piUsername": "username",
            "fos": "Computer and Information Science and Engineering",
            "opportunity": "Startup",
            "abstract": "Abstract...",
            "resources": [
                {
                    "resourceId": 530189,
                    "resourceName": "PSC Regular Memory (Bridges)",
                    "resourceType": "Compute",
                    "resourceUnits": "SUs",
                    "resourceUnitType": "Service Units",
                    "amount": "100.0",
                    "comments": "...",
                },
            ],
            "requestedResources": [
                {
                  "resourceId": 530189,
                  "resourceName": "PSC Regular Memory (Bridges)",
                  "resourceType": "Compute",
                  "resourceUnits": "SUs",
                  "resourceUnitType": "Service Units",
                  "amount": "100.0",
                  "comments": "...",
                },
            ]
        },
        ...
    ]
}

Params

Param name Description
status
optional

The status of the allocation

Validations:

  • Must be one of: active, inactive.
updatedAfter
optional

If supplied, only returns actions that were updated after the date or date/time provided

Validations:

  • Must be a DateTime

Returns

Code: 200

Description:

OK

Param name Description
actionId
required

Validations:

  • Must be a Integer
actionType
required

Validations:

  • Must be a String
beginDate
required

Validations:

  • Must be a DateTime
endDate
required

Validations:

  • Must be a DateTime
requestId
required

Validations:

  • Must be a Integer
requestTitle
required

Validations:

  • Must be a String
requestNumber
required

Validations:

  • Must be a String
pi
required

Validations:

  • Must be a String
piInstitution
required

Validations:

  • Must be a String
piUsername
required

Validations:

  • Must be a String
fos
required

Validations:

  • Must be a String
opportunity
required

Validations:

  • Must be a String
abstract
required

Validations:

  • Must be a String
resources
required

Validations:

  • Must be a Hash
resources[resourceId]
required

Validations:

  • Must be a Integer
resources[resourceName]
required

Validations:

  • Must be a String
resources[resourceType]
required

Validations:

  • Must be a String
resources[resourceUnits]
required

Validations:

  • Must be a String
resources[amount]
required

Validations:

  • Must be a Float
resources[comments]
required , nil allowed

Validations:

  • Must be a String
requestedResources
required

Validations:

  • Must be a Hash
requestedResources[resourceId]
required

Validations:

  • Must be a Integer
requestedResources[resourceName]
required

Validations:

  • Must be a String
requestedResources[resourceType]
required

Validations:

  • Must be a String
requestedResources[resourceUnits]
required

Validations:

  • Must be a String
requestedResources[amount]
required

Validations:

  • Must be a Float
requestedResources[comments]
required , nil allowed

Validations:

  • Must be a String
>>>

GET //v1/reports/username/<username>
get roles and panels for specified user

Examples

GET /v1/reports/username/<username>
{
  "message": null,
  "result": {
    "requestRoles": [
      {
        "roleName": "(PI, CoPI, Etc...)",
        "requests": [
            {
                "actionId": 41095,
                "actionType": "New",
                "beginDate": "2017-02-06",
                "endDate": "2021-08-31",
                "requestID": "000000",
                "requestTitle": "...",
                "requestNumber": "AAA123456",
                "pi": "lastName, firstName",
                "piInstitution": "InstitutionName",
                "piUsername": "username",
                "fos": "Computer and Information Science and Engineering",
                "opportunity": "Startup",
                "abstract": "Abstract...",
                "resources": [
                    {
                        "resourceId": 530189,
                        "resourceName": "PSC Regular Memory (Bridges)",
                        "resourceType": "Compute",
                        "resourceUnits": "SUs",
                        "resourceUnitType": "Service Units",
                        "amount": "100.0",
                        "comments": "...",
                    },
                    ...
                ]
            },
            ...
        ]
      },
    ],
    "panels": [
      {
        "panelName": "Educational",
        "endDate": "2029-07-12",
        "beginDate": [
          "2020-11-29",
          "2029-07-12"
        ]
      },
    ]
  }
}

Params

Param name Description
username
required

Validations:

  • Must be a String

Returns

Code: 200

Description:

OK

Param name Description
requestRoles
required

Validations:

  • Must be a Hash
requestRoles[roleName]
required

Validations:

  • Must be a String
requestRoles[requests]
required

Validations:

  • Must be a Hash
requestRoles[requests][actionId]
required

Validations:

  • Must be a Integer
requestRoles[requests][actionType]
required

Validations:

  • Must be a String
requestRoles[requests][beginDate]
required

Validations:

  • Must be a DateTime
requestRoles[requests][endDate]
required

Validations:

  • Must be a DateTime
requestRoles[requests][requestId]
required

Validations:

  • Must be a Integer
requestRoles[requests][requestTitle]
required

Validations:

  • Must be a String
requestRoles[requests][requestNumber]
required

Validations:

  • Must be a String
requestRoles[requests][pi]
required

Validations:

  • Must be a String
requestRoles[requests][piInstitution]
required

Validations:

  • Must be a String
requestRoles[requests][piUsername]
required

Validations:

  • Must be a String
requestRoles[requests][fos]
required

Validations:

  • Must be a String
requestRoles[requests][opportunity]
required

Validations:

  • Must be a String
requestRoles[requests][abstract]
required

Validations:

  • Must be a String
requestRoles[requests][resources]
required

Validations:

  • Must be a Hash
requestRoles[requests][resources][resourceId]
required

Validations:

  • Must be a Integer
requestRoles[requests][resources][resourceName]
required

Validations:

  • Must be a String
requestRoles[requests][resources][resourceType]
required

Validations:

  • Must be a String
requestRoles[requests][resources][resourceUnits]
required

Validations:

  • Must be a String
requestRoles[requests][resources][amount]
required

Validations:

  • Must be a Float
requestRoles[requests][resources][comments]
required , nil allowed

Validations:

  • Must be a String
requestRoles[requests][requestedResources]
required

Validations:

  • Must be a Hash
requestRoles[requests][requestedResources][resourceId]
required

Validations:

  • Must be a Integer
requestRoles[requests][requestedResources][resourceName]
required

Validations:

  • Must be a String
requestRoles[requests][requestedResources][resourceType]
required

Validations:

  • Must be a String
requestRoles[requests][requestedResources][resourceUnits]
required

Validations:

  • Must be a String
requestRoles[requests][requestedResources][amount]
required

Validations:

  • Must be a Float
requestRoles[requests][requestedResources][comments]
required , nil allowed

Validations:

  • Must be a String
panels
required

Validations:

  • Must be a Hash
panels[panelName]
required

Validations:

  • Must be a String
panels[endDate]
required

Validations:

  • Must be a DateTime
panels[beginDate]
required

Validations:

  • Must be a DateTime
>>>

GET //v1/reports/opportunity_requests/<opportunityId>
get requests for specified opportunity

Examples

GET /v1/reports/opportunity_requests/<opportunityId>
{
    "message": null,
    "result": [
        {
            "actionId": 41095,
            "actionType": "New",
            "beginDate": "2017-02-06",
            "endDate": "2021-08-31",
            "requestID": "000000",
            "requestTitle": "...",
            "requestNumber": "AAA123456",
            "pi": "lastName, firstName",
            "piInstitution": "InstitutionName",
            "piUsername": "username",
            "fos": "Computer and Information Science and Engineering",
            "opportunity": "Startup",
            "abstract": "Abstract...",
            "resources": [
                {
                    "resourceId": 530189,
                    "resourceName": "PSC Regular Memory (Bridges)",
                    "resourceType": "Compute",
                    "resourceUnits": "SUs",
                    "resourceUnitType": "Service Units",
                    "amount": "100.0",
                    "comments": "...",
                },
                ...
            ]
        },
        ...
    ]
}

Params

Param name Description
opportunityId
required

Validations:

  • Must be a Integer

Returns

Code: 200

Description:

OK

Param name Description
actionId
required

Validations:

  • Must be a Integer
actionType
required

Validations:

  • Must be a String
beginDate
required

Validations:

  • Must be a DateTime
endDate
required

Validations:

  • Must be a DateTime
requestId
required

Validations:

  • Must be a Integer
requestTitle
required

Validations:

  • Must be a String
requestNumber
required

Validations:

  • Must be a String
pi
required

Validations:

  • Must be a String
piInstitution
required

Validations:

  • Must be a String
piUsername
required

Validations:

  • Must be a String
fos
required

Validations:

  • Must be a String
opportunity
required

Validations:

  • Must be a String
abstract
required

Validations:

  • Must be a String
resources
required

Validations:

  • Must be a Hash
resources[resourceId]
required

Validations:

  • Must be a Integer
resources[resourceName]
required

Validations:

  • Must be a String
resources[resourceType]
required

Validations:

  • Must be a String
resources[resourceUnits]
required

Validations:

  • Must be a String
resources[amount]
required

Validations:

  • Must be a Float
resources[comments]
required , nil allowed

Validations:

  • Must be a String
requestedResources
required

Validations:

  • Must be a Hash
requestedResources[resourceId]
required

Validations:

  • Must be a Integer
requestedResources[resourceName]
required

Validations:

  • Must be a String
requestedResources[resourceType]
required

Validations:

  • Must be a String
requestedResources[resourceUnits]
required

Validations:

  • Must be a String
requestedResources[amount]
required

Validations:

  • Must be a Float
requestedResources[comments]
required , nil allowed

Validations:

  • Must be a String
>>>

GET //v1/reports/requests/<requestId>
get the specified request

Also see requests#by_id.

This returns the same response as the /v1/requests/<requestId> route, except without the “rules” object.

Params

Param name Description
requestId
required

Validations:

  • Must be a Integer
>>>

GET //v1/reports/request_numbers/<requestNumber>
get all requests by request number with the option to filter by status

Also see requests#by_id.

This returns the same response as the /v1/requests/<requestId> route, except without the “rules” object.

Params

Param name Description
requestNumber
required

Validations:

  • Must be a Integer
status
optional

The status of the request

Validations:

  • Must be one of: active, inactive.
>>>

GET //v1/reports/requests
Get all requests

Returns all requests

Params

Param name Description
limit
optional

Limit the number of requests returned

Validations:

  • Must be a Integer
prevMinRequestId
optional

If specified, will only return requests with request_id less than this parameter. Useful in conjunction with limit to paginate results

Validations:

  • Must be a Integer
fosTypeId
optional

Limit requests to those that are of this Field of Science type

Validations:

  • Must be a Integer
piOrganizationId
optional

Limit requests to those that have a PI from the specified organization

Validations:

  • Must be a Integer
status
optional

Limit requests to those with the specified status

Validations:

  • Must be one of: Submitted, Approved, Rejected, Incomplete, Under Review.
active
optional

For true, it returns Approved requests where the end date is null or in the future; for false, it returns Approved requests where the end date is in past. Cannot be specified if status is also provided

Validations:

  • Must be one of: true, false.