Opportunities

>>>

GET //v1/opportunities
get submission opportunities

Also see GET /v1/opportunities/<opportunityId>.

Examples

GET /v1/opportunities
{
   "message":null,
   "result":[ <opportunity> ]
}

Returns

Code: 200

Description:

OK

Param name Description
opportunityId
required

Validations:

  • Must be a Integer
opportunityName
required

Validations:

  • Must be a String
displayOpportunityName
required

Validations:

  • Must be a String
opportunityType
required

Validations:

  • Must be a String
announcementDate
required

Validations:

  • Must be a String
submissionBeginDate
required

Validations:

  • Must be a DateTime
submissionEndDate
required

Validations:

  • Must be one of: DateTime, nil.
submissionURL
required

Validations:

  • Must be one of: String, nil.
submissionNotes
required

Validations:

  • Must be a String
defaultAllocationAwardPeriod
required

Validations:

  • Must be one of: Integer, nil.
adminComments
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[displayResourceName]
required

Validations:

  • Must be a String
resources[resourceType]
required

Validations:

  • Must be a String
resources[resourceActualType]
required

Validations:

  • Must be a String
resources[resourceUnits]
required

Validations:

  • Must be a String
resources[resourceUnitType]
required

Validations:

  • Must be a String
resources[resourceState]
required

Validations:

  • Must be a String
resources[siteProviderComments]
required

Validations:

  • Must be a String
resources[relativeOrder]
required

Validations:

  • Must be a Integer
resources[requiredResources]
required

Validations:

  • Must be a Hash
resources[requiredResources][resourceId]
required

Validations:

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

Validations:

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

Validations:

  • Must be a String
resources[requiredResources][beginDate]
required

Validations:

  • Must be a DateTime
resources[requiredResources][endDate]
required

Validations:

  • Must be a DateTime
resources[numbers]
required

Validations:

  • Must be a Hash
resources[numbers][source]
required

Validations:

  • Must be one of: opportunity, allocationType.
resources[numbers][amount]
required

Validations:

  • Must be a Integer
resources[numbers][beginDate]
required

Validations:

  • Must be a DateTime
resources[numbers][endDate]
required

Validations:

  • Must be a DateTime
resources[numbers][resourceNumberTypeId]
required

Validations:

  • Must be a Integer
resources[numbers][resourceNumberType]
required

Validations:

  • Must be a String
resources[numbers][displayResourceNumberType]
required

Validations:

  • Must be a String
resources[allocationType]
required

Validations:

  • Must be a String
resources[allocationTypeInfo]
required

Validations:

  • Must be a Hash
resources[allocationTypeId]
required

Validations:

  • Must be a Integer
resources[description]
required

Validations:

  • Must be a String
resources[numSubmissions]
required

Validations:

  • Must be one of: Integer, nil.
resources[isActive]
required

Validations:

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

Validations:

  • Must be a Hash
panels[panelId]
required

Validations:

  • Must be a Integer
panels[isPrimary]
required

Validations:

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

Validations:

  • Must be an array of String
attributeSets
required

Validations:

  • Must be a Hash
attributeSets[resourceAttributeId]
required

Validations:

  • Must be a Integer
attributeSets[attributeValue]
required

Validations:

  • Must be one of: String, nil.
terminatingOpportunity
required

Validations:

  • Must be a Hash
terminatingOpportunity[awardDate]
required

Validations:

  • Must be one of: DateTime, nil.
terminatingOpportunity[reviewDate]
required

Validations:

  • Must be one of: DateTime, nil.
terminatingOpportunity[gracePeriod]
required

Validations:

  • Must be one of: Integer, nil.
terminatingOpportunity[reviewsDueByDate]
required

Validations:

  • Must be one of: DateTime, nil.
rules
required

Validations:

  • Must be a Hash
rules[opportunityId]
required

Validations:

  • Must be a Integer
rules[canSubmitNewRequest]
required

Validations:

  • Must be one of: true, false.
rules[noAvailableActionsReason]
required

Validations:

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

Validations:

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

Validations:

  • Must be a Integer
>>>

GET //v1/opportunities/list/id1,id2,...
get a list of opportunities

Also see GET /v1/opportunities/<opportunityId>.

Examples

GET /v1/opportunities/list/id1[,id2...]
{
   "message":null,
   "result":[ <opportunity> ]
}

Params

Param name Description
opportunityId
required

A comma delimited list of opportunity ids

Validations:

  • Must be a String

Returns

Code: 200

Description:

OK

Param name Description
opportunityId
required

Validations:

  • Must be a Integer
opportunityName
required

Validations:

  • Must be a String
displayOpportunityName
required

Validations:

  • Must be a String
opportunityType
required

Validations:

  • Must be a String
announcementDate
required

Validations:

  • Must be a String
submissionBeginDate
required

Validations:

  • Must be a DateTime
submissionEndDate
required

Validations:

  • Must be one of: DateTime, nil.
submissionURL
required

Validations:

  • Must be one of: String, nil.
submissionNotes
required

Validations:

  • Must be a String
defaultAllocationAwardPeriod
required

Validations:

  • Must be one of: Integer, nil.
adminComments
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[displayResourceName]
required

Validations:

  • Must be a String
resources[resourceType]
required

Validations:

  • Must be a String
resources[resourceActualType]
required

Validations:

  • Must be a String
resources[resourceUnits]
required

Validations:

  • Must be a String
resources[resourceUnitType]
required

Validations:

  • Must be a String
resources[resourceState]
required

Validations:

  • Must be a String
resources[siteProviderComments]
required

Validations:

  • Must be a String
resources[relativeOrder]
required

Validations:

  • Must be a Integer
resources[requiredResources]
required

Validations:

  • Must be a Hash
resources[requiredResources][resourceId]
required

Validations:

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

Validations:

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

Validations:

  • Must be a String
resources[requiredResources][beginDate]
required

Validations:

  • Must be a DateTime
resources[requiredResources][endDate]
required

Validations:

  • Must be a DateTime
resources[numbers]
required

Validations:

  • Must be a Hash
resources[numbers][source]
required

Validations:

  • Must be one of: opportunity, allocationType.
resources[numbers][amount]
required

Validations:

  • Must be a Integer
resources[numbers][beginDate]
required

Validations:

  • Must be a DateTime
resources[numbers][endDate]
required

Validations:

  • Must be a DateTime
resources[numbers][resourceNumberTypeId]
required

Validations:

  • Must be a Integer
resources[numbers][resourceNumberType]
required

Validations:

  • Must be a String
resources[numbers][displayResourceNumberType]
required

Validations:

  • Must be a String
resources[allocationType]
required

Validations:

  • Must be a String
resources[allocationTypeInfo]
required

Validations:

  • Must be a Hash
resources[allocationTypeId]
required

Validations:

  • Must be a Integer
resources[description]
required

Validations:

  • Must be a String
resources[numSubmissions]
required

Validations:

  • Must be one of: Integer, nil.
resources[isActive]
required

Validations:

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

Validations:

  • Must be a Hash
panels[panelId]
required

Validations:

  • Must be a Integer
panels[isPrimary]
required

Validations:

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

Validations:

  • Must be an array of String
attributeSets
required

Validations:

  • Must be a Hash
attributeSets[resourceAttributeId]
required

Validations:

  • Must be a Integer
attributeSets[attributeValue]
required

Validations:

  • Must be one of: String, nil.
terminatingOpportunity
required

Validations:

  • Must be a Hash
terminatingOpportunity[awardDate]
required

Validations:

  • Must be one of: DateTime, nil.
terminatingOpportunity[reviewDate]
required

Validations:

  • Must be one of: DateTime, nil.
terminatingOpportunity[gracePeriod]
required

Validations:

  • Must be one of: Integer, nil.
terminatingOpportunity[reviewsDueByDate]
required

Validations:

  • Must be one of: DateTime, nil.
rules
required

Validations:

  • Must be a Hash
rules[opportunityId]
required

Validations:

  • Must be a Integer
rules[canSubmitNewRequest]
required

Validations:

  • Must be one of: true, false.
rules[noAvailableActionsReason]
required

Validations:

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

Validations:

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

Validations:

  • Must be a Integer
>>>

GET //v1/opportunities/<opportunityId>
get the specified submission opportunity

Examples

GET /v1/opportunities/530290
{
    "message": null,
    "result": {
        "opportunityId": 530290,
        "opportunityName": "Small Request w/ NSF Award",
        "displayOpportunityName": "Small Request w/ NSF Award",
        "opportunityType": "Continuous",
        "announcementDate": "2015-08-06",
        "submissionBeginDate": "2015-08-06",
        "submissionEndDate": null,
        "submissionURL": null,
        "submissionNotes": "Documentation for completing the form: <a href=\"https://www2.cisl.ucar.edu/docs/allocations/university_small_request\" target=\"_blank\">NCAR/CISL web site</a>",
        "defaultAllocationAwardPeriod": null,
        "adminComments": "If you do not have a NCAR login, please send a phone number and a FedEx mailing address, preferably at the university, to cislhelp@ucar.edu. You can also send contact information for any additional users needing access to your project.",
        "resources": [
            {
                "resourceId": 530181,
                "resourceName": "Yellowstone (IBM iDataPlex cluster)",
                "displayResourceName": "Yellowstone (IBM iDataPlex cluster)",
                "resourceType": "Compute",
                "resourceActualType": "Compute",
                "resourceUnits": "Core-hours",
                "resourceUnitType": "Core-hours",
                "resourceState": "Production",
                "siteProviderComments": "<a href=\"https://www2.cisl.ucar.edu/resources/yellowstone\" target=\"_blank\">Yellowstone</a> is a 1.5-petaflops, high-performance computing cluster for your primary science runs.",
                "relativeOrder": 2,
                "requiredResources": [
                ],
                "numbers": [
                ]
            },
            {
                "resourceId": 530182,
                "resourceName": "Janus (CU-Boulder Dell cluster)",
                "displayResourceName": "Janus (CU-Boulder Dell cluster)",
                "resourceType": "Compute",
                "resourceActualType": "Compute",
                "resourceUnits": "Core-hours",
                "resourceUnitType": "Core-hours",
                "resourceState": "Unavailable",
                "siteProviderComments": null,
                "relativeOrder": 7,
                "requiredResources": [
                ],
                "numbers": [
                ]
            },
            {
                "resourceId": 530183,
                "resourceName": "Geyser & Caldera (Data Analysis and Visualization clusters)",
                "displayResourceName": "Geyser & Caldera (Data Analysis and Visualization clusters)",
                "resourceType": "Compute",
                "resourceActualType": "Compute",
                "resourceUnits": "Core-hours",
                "resourceUnitType": "Core-hours",
                "resourceState": "Production",
                "siteProviderComments": "The <a href=\"https://www2.cisl.ucar.edu/resources/geyser_caldera\" target=\"_blank\">Geyser and Caldera</a> clusters are specialized resources for analyzing and visualizing data",
                "relativeOrder": 3,
                "requiredResources": [
                ],
                "numbers": [
                ]
            },
            {
                "resourceId": 530184,
                "resourceName": "HPSS Storage System",
                "displayResourceName": "HPSS Storage System",
                "resourceType": "Storage",
                "resourceActualType": "Storage",
                "resourceUnits": "TB",
                "resourceUnitType": "TeraBytes",
                "resourceState": "Production",
                "siteProviderComments": "<a href=\"https://www2.cisl.ucar.edu/docs/hpss/policies\" target=\"_blank\">HPSS</a> is for long-term storage of data—data sets larger than 100 MB, for example, that need to be kept for 30 days or more.",
                "relativeOrder": 6,
                "requiredResources": [
                ],
                "numbers": [
                ]
            },
            {
                "resourceId": 530185,
                "resourceName": "GLADE Project Space",
                "displayResourceName": "GLADE Project Space",
                "resourceType": "Storage",
                "resourceActualType": "Storage",
                "resourceUnits": "TB",
                "resourceUnitType": "TeraBytes",
                "resourceState": "Production",
                "siteProviderComments": "The <a href=\"https://www2.cisl.ucar.edu/resources/glade\" target=\"_blank\">Globally Accessible Data Environment</a> is centralized disk storage that is accessible from the Yellowstone, Geyser, and Caldera clusters.",
                "relativeOrder": 5,
                "requiredResources": [
                ],
                "numbers": [
                ]
            },
            {
                "resourceId": 530195,
                "resourceName": "CMIP Analysis Platform",
                "displayResourceName": "CMIP Analysis Platform",
                "resourceType": "Data",
                "resourceActualType": "Data",
                "resourceUnits": "[Yes = 1, No = 0]",
                "resourceUnitType": "[Yes = 1, No = 0]",
                "resourceState": "Production",
                "siteProviderComments": "<a href=\"https://www2.cisl.ucar.edu/docs/cmip_ap\" target=\"_blank\">The CMIP Analysis Platform</a> gives researchers access to climate data from the Coupled Model Intercomparison Project (CMIP) on CISL’s GLADE disk resource for processing with the Geyser and Caldera analysis and visualization clusters.",
                "relativeOrder": 4,
                "requiredResources": [
                    {
                        "resourceId": 530183,
                        "resourceName": "Geyser & Caldera (Data Analysis and Visualization clusters)",
                        "displayResourceName": "Geyser & Caldera (Data Analysis and Visualization clusters)",
                        "beginDate": "2016-01-01",
                        "endDate": null
                    }
                ],
                "numbers": [
                ]
            }
        ],
        "allocationType": "Small",
        "allocationTypeInfo": {
            "allocationTypeId": 500024,
            "allocationType": "Small",
            "description": "U.S. university researchers who are supported by NSF awards can request a small allocation of up to 200,000 \ncore-hours on Yellowstone for each NSF award. \nSmall requests typically receive a partial allocation within a few business days.",
            "numSubmissions": null,
            "isActive": true,
            "relativeOrder": 2
        },
        "panels": [
            {
                "panelId": 500021,
                "isPrimary": true
            }
        ],
        "opportunityStates": [
            "Reviewers Assignments Visible",
            "Reviews Visible",
            "Reviewer Ratings Visible"
        ],
        "attributeSets": [
        ],
        "terminatingOpportunity": {
            "awardDate": null,
            "reviewDate": null,
            "gracePeriod": null,
            "reviewsDueByDate": null
        },
        "rules": {
            "opportunityId": 530290,
            "canSubmitNewRequest": true,
            "noAvailableActionsReason": [
            ],
            "resourceIdsAvailableForNewRequest": [
                "530185",
                "530181",
                "530195",
                "530184",
                "530183"
            ],
            "gracePeriod": 0,
            "availableActionRequests": [
            ]
        }
    }
}