Requests

Examples

GET /v1/requests
{
   "message":null,
   "result":[ <request> ]
}

Returns

Code: 200

Description:

OK

Examples

GET /v1/requests/1165253
{
    "message": null,
    "result": {
        "rules": {
            "requestId": 1171234,
            "allowedOperations": [
            ],
            "allowedActions": [
                "Advance"
            ],
            "allowedActionsRes": [
                {
                    "actionType": "Advance",
                    "availableResourceIds": [
                        "530126",
                        "530162",
                        "530174",
                        "530170",
                        "530155",
                        "530173",
                        "530198",
                        "530157",
                        "530165",
                        "530159",
                        "530190",
                        "530154",
                        "530171",
                        "530188",
                        "530191",
                        "530192",
                        "530189",
                        "530175"
                    ]
                }
            ],
            "existingActions": [
                {
                    "actionId": 37761,
                    "actionType": "New",
                    "allowedOperations": [
                    ],
                    "reviewsViewable": false
                }
            ]
        },
        "requestId": 1171234,
        "requestType": "New",
        "requestStatus": "Under Review",
        "requestNumber": "MCB160124",
        "opportunityId": 530306,
        "isDeleted": false,
        "title": "Online Platform for I-TASSER-Based Structure and Function Prediction",
        "shortTitle": null,
        "abstract": "Proteins are biological macromolecules that perform a multitude of tasks within cells, such as repairing genomic DNA or helping cells respond to certain stimuli. As a result, they have been the subject of intense research in the realm of life sciences for over a century. Iterative threading assembly refinement (I-TASSER) is a hierarchical method developed in the PI’s lab that was designed to construct full-length protein structure models, starting from amino acid sequences, by assembling continuous fragments excised from threading template alignments, using iterative Replica-exchange Monte Carlo (REMC) simulations. The functional insights of the target proteins, including enzyme commission, gene ontology and ligand binding sites, are then derived by matching the structural models with the known protein function databases. The I-TASSER method has been consistently ranked as one of the best methods for automated protein structure prediction in the community-wide CASP experiments. Meanwhile, the function prediction components of the I-TASSER pipeline, including COFACTOR and COACH, have been ranked at the top for protein function annotation in the community-wide CASP and CAMEO experiments. In addition, the QUARK algorithm provides structure modeling in the absence of templates. The PI owns a web server that hosts all the aforementioned algorithms, in addition to several others, and one of its major purposes is to provide reliable structure and function predictions for the biomedical community; with this, scientists working in the life sciences can use the models to assist their own research studies. The online I-TASSER server is currently one of the most widely-used, reliable systems in the field for high-resolution protein structure and function modeling, but the limitation of computing resources in the PI’s lab has become a major bottleneck for the application to the community. The XSEDE resource will help remove the resource barrier and significantly enhance its impact to the broader community. The I-TASSER server is one of the most widely used systems in the field for online, full-length protein structure and function prediction. As of July 14, 2016, the webserver has already predicted 280,269 protein structures for 70,013 users from 125 countries, with 17,942 users coming from the United States. In this project, we seek to utilize XSEDE computing resources to improve the ability and capacity of the I-TASSER system for serving the community, by implementing the I-TASSER server as an XSEDE Science Gateway.",
        "submitDate": "2016-07-15T19:32:07Z",
        "isSupportedByGrants": true,
		"grantTypeId": null,
        "actions": [
            {
                "actionId": 37761,
                "actionType": "New",
                "actionStatus": "Under Review",
                "isDeleted": false,
                "userComments": null,
                "adminComments": null,
                "collaborators": null,
                "states": [
                    "Conflicts Verified",
                    "Reviewers Assigned"
                ],
                "resources": [
                    {
                        "resourceId": 530165,
                        "resourceName": "SDSC Medium-term disk storage (Data Oasis)",
                        "displayResourceName": "SDSC Medium-term disk storage (Data Oasis)",
                        "resourceType": "Storage",
                        "resourceActualType": "Storage",
                        "resourceUnits": "GB",
                        "resourceUnitType": "GigaBytes",
                        "amount": "3100.0",
                        "comments": null,
                        "type": "Requested"
                    },
                    {
                        "resourceId": 530173,
                        "resourceName": "SDSC Dell Cluster with Intel Haswell Processors (Comet)",
                        "displayResourceName": "SDSC Dell Cluster with Intel Haswell Processors (Comet)",
                        "resourceType": "Compute",
                        "resourceActualType": "Compute",
                        "resourceUnits": "SUs",
                        "resourceUnitType": "Service Units",
                        "amount": "10000000.0",
                        "comments": null,
                        "type": "Requested"
                    }
                ],
                "documents": [
                    {
                        "documentId": 36785,
                        "documentType": "Code_Perf_Scale",
                        "title": "Scalability and Performance",
                        "filename": "Scalability and Performance.pdf",
                        "size": 122938
                    },
                    {
                        "documentId": 36782,
                        "documentType": "References",
                        "title": "References",
                        "filename": "References.pdf",
                        "size": 465867
                    },
                    {
                        "documentId": 36781,
                        "documentType": "MainDoc",
                        "title": "Main Document",
                        "filename": "Main Document.pdf",
                        "size": 911771
                    },
                    {
                        "documentId": 36505,
                        "documentType": "Other",
                        "title": "ResQ Paper",
                        "filename": "ResQ.pdf",
                        "size": 1620781
                    },
                    {
                        "documentId": 36504,
                        "documentType": "Other",
                        "title": "GPCR-I-TASSER Paper",
                        "filename": "GPCR-I-TASSER.pdf",
                        "size": 2745001
                    },
                    {
                        "documentId": 36503,
                        "documentType": "Other",
                        "title": "I-TASSER Suite Paper",
                        "filename": "I-TASSER suite.pdf",
                        "size": 7903972
                    },
                    {
                        "documentId": 36502,
                        "documentType": "Other",
                        "title": "I-TASSER server",
                        "filename": "I-TASSER server.pdf",
                        "size": 3008533
                    },
                    {
                        "documentId": 36500,
                        "documentType": "Other",
                        "title": "I-TASSER Nature Protocols",
                        "filename": "I-TASSER Nature Protocols.pdf",
                        "size": 1942724
                    },
                    {
                        "documentId": 36499,
                        "documentType": "CV_PI",
                        "title": "Biosketch Zhang",
                        "filename": "Biosketch (Yang Zhang).pdf",
                        "size": 19015
                    },
                    {
                        "documentId": 36498,
                        "documentType": "CV_CoPI",
                        "title": "Biosketch Chan",
                        "filename": "Biosketch (Wallace Chan).pdf",
                        "size": 121897
                    },
                    {
                        "documentId": 36497,
                        "documentType": "CV_CoPI",
                        "title": "Biosketch Jouko",
                        "filename": "Biosketch (Jouko Virtanen).pdf",
                        "size": 15687
                    }
                ],
                "allocationDates": [
                ],
                "opportunityAttributes": [
                ],
                "resourceAttributes": [
                    {
                        "resourceAttributeId": 533314,
                        "attributeValue": "",
                        "resourceId": 530173
                    },
                    {
                        "resourceAttributeId": 533315,
                        "attributeValue": "No",
                        "resourceId": 530173
                    }
                ]
            }
        ],
        "roles": [
            {
                "person": {
                    "username": "hackwort",
                    "firstName": "Ken",
                    "middleName": null,
                    "lastName": "Hackworth",
                    "email": "hackworth@psc.edu",
                    "phone": "412-268-7081",
                    "organization": "Pittsburgh Supercomputing Center",
                    "academicStatus": "Center Non-Researcher Staff",
                    "residenceCountry": "United States",
                    "isReconciled": true
                },
                "roles": [
                    {
                        "roleId": 49631,
                        "role": "Allocation Manager",
                        "roleTypeId": 3,
                        "beginDate": "2016-07-15",
                        "endDate": null,
                        "isAccountToBeCreated": true
                    }
                ]
            },
            {
                "person": {
                    "username": "wallakin",
                    "firstName": "Wallace",
                    "middleName": null,
                    "lastName": "Chan",
                    "email": "wallakin@umich.edu",
                    "phone": "(734) 647-6842",
                    "organization": "University of Michigan Medical School",
                    "academicStatus": "Graduate Student",
                    "residenceCountry": "United States",
                    "isReconciled": true
                },
                "roles": [
                    {
                        "roleId": 49235,
                        "role": "CoPI",
                        "roleTypeId": 1,
                        "beginDate": "2016-07-14",
                        "endDate": null,
                        "isAccountToBeCreated": true
                    }
                ]
            },
            {
                "person": {
                    "username": "joukov",
                    "firstName": "Jouko",
                    "middleName": "Juhani",
                    "lastName": "Virtanen",
                    "email": "jouko@umich.edu",
                    "phone": "734-709-3936",
                    "organization": "University of Michigan",
                    "academicStatus": "Postdoctorate",
                    "residenceCountry": "United States",
                    "isReconciled": true
                },
                "roles": [
                    {
                        "roleId": 49231,
                        "role": "CoPI",
                        "roleTypeId": 1,
                        "beginDate": "2016-07-14",
                        "endDate": null,
                        "isAccountToBeCreated": true
                    }
                ]
            },
            {
                "person": {
                    "username": "zcx",
                    "firstName": "chengxin",
                    "middleName": null,
                    "lastName": "zhang",
                    "email": "zcx@umich.edu",
                    "phone": "7347809411",
                    "organization": "University of Michigan",
                    "academicStatus": "Graduate Student",
                    "residenceCountry": "United States",
                    "isReconciled": true
                },
                "roles": [
                    {
                        "roleId": 49234,
                        "role": "User",
                        "roleTypeId": 9,
                        "beginDate": "2016-07-14",
                        "endDate": null,
                        "isAccountToBeCreated": true
                    }
                ]
            },
            {
                "person": {
                    "username": "zhng",
                    "firstName": "Yang",
                    "middleName": null,
                    "lastName": "Zhang",
                    "email": "zhng@umich.edu",
                    "phone": "734-647-1549",
                    "organization": "University of Michigan",
                    "academicStatus": "Faculty",
                    "residenceCountry": "United States",
                    "isReconciled": true
                },
                "roles": [
                    {
                        "roleId": 49233,
                        "role": "PI",
                        "roleTypeId": 2,
                        "beginDate": "2016-07-14",
                        "endDate": null,
                        "isAccountToBeCreated": true
                    }
                ]
            }
        ],
        "fos": [
            {
                "fosTypeId": 64,
                "fosNum": "411",
                "isPrimary": true
            }
        ],
        "keywords": "QUARK,protein structure prediction,protein function prediction,I-TASSER,COFACTOR,COACH,ligand binding site prediction,active site prediction",
        "grants": [
            {
                "grantId": 17513,
                "fundingAgencyId": 15,
                "grantNumber": "5R01GM083107-09",
                "piName": "Yang Zhang",
                "title": "I-TASSER based atomic-level protein structure prediction",
                "beginDate": "2008-04-01",
                "endDate": "2017-06-30",
                "awardedAmount": "285747.0",
                "awardedUnits": "Dollars",
                "percentageAward": "100.0",
                "programOfficerName": "Janna Wehrle",
                "programOfficerEmail": "wehrlej@nigms.nih.gov",
                "isPending": false,
                "subAwardNumber": null,
                "comments": null,
                "primaryFosTypeId": 64
            },
            {
                "grantId": 17512,
                "fundingAgencyId": 15,
                "grantNumber": "1R01GM116960-01",
                "piName": "Yang Zhang",
                "title": "Template-based docking refinement approach to protein-protein structure modeling",
                "beginDate": "2016-01-01",
                "endDate": "2019-12-31",
                "awardedAmount": "357925.0",
                "awardedUnits": "Dollars",
                "percentageAward": "100.0",
                "programOfficerName": "Janna Wehrle",
                "programOfficerEmail": "wehrlej@nigms.nih.gov",
                "isPending": false,
                "subAwardNumber": null,
                "comments": null,
                "primaryFosTypeId": 64
            }
        ],
        "conflicts": [
            {
                "conflictId": 29497,
                "conflictType": "Institutional",
                "conflictPerson": "chemtw"
            }
        ],
        "publications": [
            {
                "publicationId": 9395,
                "publication": {
                    "id": 7647,
                    "title": "REMO: A new protocol to refine full atomic protein models from C-alpha traces by optimizing hydrogen-bonding networks",
                    "doi": "10.1002/prot.22380",
                    "pubMedId": "19274737",
                    "bibtex": "@article{Li_2009,\n\tdoi = {10.1002/prot.22380},\n\turl = {http://dx.doi.org/10.1002/prot.22380},\n\tyear = 2009,\n\tmonth = {aug},\n\tpublisher = {Wiley-Blackwell},\n\tvolume = {76},\n\tnumber = {3},\n\tpages = {665--676},\n\tauthor = {Yunqi Li and Yang Zhang},\n\ttitle = {{REMO}: A new protocol to refine full atomic protein models from C-alpha traces by optimizing hydrogen-bonding networks},\n\tjournal = {Proteins}\n}",
                    "year": 2009,
                    "month": 8,
                    "peerReviewed": false,
                    "type": {"id": 2, "name": "Journal Article"},
                    "abstractText": null,
                    "createdBy": "zhng",
                    "created": 1456000960860,
                    "modifiedBy": "zhng",
                    "modified": 1456000960860,
                    "projects": [],
                    "authors": [
                        {
                            "id": 40877,
                            "order": 0,
                            "author": {
                                "id": 41070,
                                "portalUsername": null,
                                "firstName": "Yunqi",
                                "middleName": "",
                                "lastName": "Li",
                                "prefix": null,
                                "suffix": null,
                                "initials": null,
                                "affiliation": null,
                                "hash": "30b429854406e383490549c283d58c2d"
                            }
                        },
                        {
                            "id": 40878,
                            "order": 1,
                            "author": {
                                "id": 41071,
                                "portalUsername": "zhng",
                                "firstName": "Yang",
                                "middleName": "",
                                "lastName": "Zhang",
                                "prefix": null,
                                "suffix": null
                                "initials": null,
                                "affiliation": null,
                                "hash": "30f680a8599f4dd075dc2b89623c2114"
                            }
                        }
                    ],
                    "data": [
                        {
                            "id": 29995,
                            "field": {
                                "id": 6,
                                "name": "Journal name",
                                "description": "The name of the Journal",
                                "type": "textfield",
                                "sortOrder": 0,
                                "required": true,
                                "defaultValue": null,
                                "options": null
                            },
                            "value": "Proteins"
                        },
                        {
                            "id": 29996,
                            "field": {
                                "id": 7,
                                "name": "Volume/Issue",
                                "description": "",
                                "type": "textfield",
                                "sortOrder": 1,
                                "required": false,
                                "defaultValue": null,
                                "options": null
                            },
                            "value": "3"
                        },
                        {
                            "id": 29997,
                            "field": {
                                "id": 8,
                                "name": "Pages",
                                "description": "",
                                "type": "textfield",
                                "sortOrder": 2,
                                "required": false,
                                "defaultValue": null,
                                "options": null
                            },
                            "value": "665-676"
                        },
                        {
                            "id": 29998,
                            "field": {
                                "id": 9,
                                "name": "URL",
                                "description": "",
                                "type": "textfield",
                                "sortOrder": 3,
                                "required": false,
                                "defaultValue": null,
                                "options": null
                            },
                            "value": "http://dx.doi.org/10.1002/prot.22380"
                        }
                    ]
                }
            }
        ]
    }
}

Params

Returns

Code: 200

Description:

OK

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

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Examples

POST /v1/requests/1116002/renew?opportunityId=2
{
    "message": null,
    "result": {
        "rules": {
            "requestId": 1188805,
            "allowedOperations": [
                "Edit",
                "Delete"
            ],
            "allowedActions": [
            ],
            "allowedActionsRes": [
            ],
            "existingActions": [
                {
                    "actionId": 66149,
                    "actionType": "Renewal",
                    "allowedOperations": [
                        "Edit",
                        "Delete"
                    ],
                    "reviewsViewable": false
                }
            ]
        },
        "requestId": 1188805,
        "requestType": "Renewal",
        "requestStatus": "Incomplete",
        "requestNumber": "MCA06N060",
        "opportunityId": 2,
        "isDeleted": false,
        "title": "Large Scale Simulation of Membrane Channels and Transporters",
        "shortTitle": null,
        "abstract": null,
        "submitDate": null,
        "isSupportedByGrants": true,
        "actions": [
            {
                "actionId": 66149,
                "actionType": "Renewal",
                "actionStatus": "Incomplete",
                "finalReviews": [
                ],
                "isDeleted": false,
                "userComments": null,
                "adminComments": null,
                "collaborators": null,
                "finalReview": "",
                "states": [
                ],
                "resources": [
                ],
                "documents": [
                ],
                "allocationDates": [
                ],
                "opportunityAttributes": [
                ],
                "resourceAttributes": [
                ]
            }
        ],
        "roles": [
            {
                "person": {
                    "username": "noahtreb",
                    "firstName": "Noah",
                    "middleName": "Alexander",
                    "lastName": "Trebesch",
                    "email": "trebesc2@illinois.edu",
                    "phone": "651-357-0311",
                    "organization": "University of Illinois at Urbana-Champaign",
                    "academicStatus": "Graduate Student",
                    "residenceCountry": "United States",
                    "isReconciled": true
                },
                "roles": [
                    {
                        "roleId": 92621,
                        "role": "Allocation Manager",
                        "roleTypeId": 3,
                        "beginDate": "2018-06-29",
                        "endDate": null,
                        "isAccountToBeCreated": false
                    }
                ]
            },
            {
                "person": {
                    "username": "pochao",
                    "firstName": "Po-Chao",
                    "middleName": null,
                    "lastName": "Wen",
                    "email": "pwen2@illinois.edu",
                    "phone": "217-300-1434",
                    "organization": "University of Illinois at Urbana-Champaign",
                    "academicStatus": "Postdoctorate",
                    "residenceCountry": "United States",
                    "isReconciled": true
                },
                "roles": [
                    {
                        "roleId": 92620,
                        "role": "Allocation Manager",
                        "roleTypeId": 3,
                        "beginDate": "2018-06-29",
                        "endDate": null,
                        "isAccountToBeCreated": false
                    }
                ]
            },
            {
                "person": {
                    "username": "sundar81",
                    "firstName": "Sundarapandian",
                    "middleName": null,
                    "lastName": "Thangapandian",
                    "email": "sundar81@illinois.edu",
                    "phone": "217-721-1817",
                    "organization": "University of Illinois at Urbana-Champaign",
                    "academicStatus": "Postdoctorate",
                    "residenceCountry": "United States",
                    "isReconciled": true
                },
                "roles": [
                    {
                        "roleId": 92619,
                        "role": "Allocation Manager",
                        "roleTypeId": 3,
                        "beginDate": "2017-03-17",
                        "endDate": null,
                        "isAccountToBeCreated": false
                    }
                ]
            },
            {
                "person": {
                    "username": "mayne",
                    "firstName": "Christopher",
                    "middleName": "Glenn",
                    "lastName": "Mayne",
                    "email": "cmayne2@uiuc.edu",
                    "phone": "217-300-6380",
                    "organization": "University of Illinois at Urbana-Champaign",
                    "academicStatus": "Postdoctorate",
                    "residenceCountry": "United States",
                    "isReconciled": true
                },
                "roles": [
                    {
                        "roleId": 92618,
                        "role": "Allocation Manager",
                        "roleTypeId": 3,
                        "beginDate": "2017-03-17",
                        "endDate": null,
                        "isAccountToBeCreated": false
                    }
                ]
            },
            {
                "person": {
                    "username": "paween",
                    "firstName": "Paween",
                    "middleName": null,
                    "lastName": "Mahinthichaichan",
                    "email": "mahinth1@illinois.edu",
                    "phone": "217-300-9066",
                    "organization": "University of Illinois at Urbana-Champaign",
                    "academicStatus": "Postdoctorate",
                    "residenceCountry": "United States",
                    "isReconciled": true
                },
                "roles": [
                    {
                        "roleId": 92617,
                        "role": "Allocation Manager",
                        "roleTypeId": 3,
                        "beginDate": "2017-03-17",
                        "endDate": null,
                        "isAccountToBeCreated": false
                    }
                ]
            },
            {
                "person": {
                    "username": "emad",
                    "firstName": "Emad",
                    "middleName": null,
                    "lastName": "Tajkhorshid",
                    "email": "emad@life.illinois.edu",
                    "phone": "217-244-6914",
                    "organization": "University of Illinois at Urbana-Champaign",
                    "academicStatus": "Faculty",
                    "residenceCountry": "United States",
                    "isReconciled": true
                },
                "roles": [
                    {
                        "roleId": 92616,
                        "role": "Allocation Manager",
                        "roleTypeId": 3,
                        "beginDate": "2007-07-13",
                        "endDate": null,
                        "isAccountToBeCreated": false
                    },
                    {
                        "roleId": 92615,
                        "role": "PI",
                        "roleTypeId": 2,
                        "beginDate": "2007-07-13",
                        "endDate": null,
                        "isAccountToBeCreated": true
                    }
                ]
            },
            {
                "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": 92614,
                        "role": "Allocation Manager",
                        "roleTypeId": 3,
                        "beginDate": "2019-01-17",
                        "endDate": null,
                        "isAccountToBeCreated": false
                    }
                ]
            }
        ],
        "fos": [
            {
                "fosTypeId": 65,
                "fosNum": "412",
                "isPrimary": false
            },
            {
                "fosTypeId": 64,
                "fosNum": "411",
                "isPrimary": true
            }
        ],
        "keywords": "mitochondrial transport,gas permeation,structre-function relationship,protein structure,electrostatic induced conformational transition,mechanical response,molecular dynamics,membrane proteins,transport phenomena,membrane channels",
        "grants": [
            {
                "grantId": 27566,
                "fundingAgencyId": 18,
                "grantNumber": "N/A",
                "piName": "Emad Tajkhorshid",
                "title": "Tajkhorshid Startup Package",
                "beginDate": "2006-08-16",
                "endDate": "2040-12-31",
                "awardedAmount": "620000.0",
                "awardedUnits": "Dollars",
                "percentageAward": "100.0",
                "programOfficerName": "Ann Zielinski",
                "programOfficerEmail": "azielins@life.uiuc.edu",
                "isPending": false,
                "subAwardNumber": null,
                "comments": null,
                "primaryFosTypeId": 64
            }
        ],
        "conflicts": [
        ],
        "publications": [
        ]
    }
}

Params

Returns

Code: 200

Description:

OK

Examples

GET /v1/requests/1/reviews
{
   "message":null,
   "result":{
      "requestId":1,
      "actions":[
         {
            "actionId":1,
            "reviews":[
               {
                  "reviewId":102,
                  "dateReviewed":"2013-10-28",
                  "review":"review by AMIE/Amy",
                  "researchPlan":"researchPlan",
                  "methodology":"methodology",
                  "resourcesUse":"resourceUse la la ",
                  "overallRating":"Excellent",
                  "resources":[
                     {
                        "resourceId":5,
                        "suggestedAmount":"55555.0",
                        "comments":null
                     }
                  ]
               },
               {
                  "reviewId":103,
                  "dateReviewed":"2013-10-29",
                  "review":"my blah blah blah one more time review",
                  "researchPlan":"",
                  "methodology":"",
                  "resourcesUse":"ajkshdkajsdh",
                  "overallRating":"Good",
                  "resources":[
                     {
                        "resourceId":1,
                        "suggestedAmount":"1200.0",
                        "comments":"blah blah blah"
                     },
                     {
                        "resourceId":2,
                        "suggestedAmount":"22222.0",
                        "comments":""
                     },
                     {
                        "resourceId":3,
                        "suggestedAmount":"1000.0",
                        "comments":""
                     },
                     {
                        "resourceId":5,
                        "suggestedAmount":"55555.0",
                        "comments":""
                     }
                  ]
               }
            ]
         },
         {
            "actionId":6,
            "reviews":[

            ]
         },
         {
            "actionId":2,
            "reviews":[

            ]
         }
      ]
   }
}

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Params

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Examples

Validation successful
POST /v1/requests/1158774/actions/12593/submit
{
   "message":null,
   "result":[ <request> ]
}

Validation failure
POST /v1/requests/1162274/actions/13744/submit
400 Bad Request
{
	"message":"validation failed",
	"result":{
		"validation":"failed",
		"errors":[
		"Title is a required field",
		"Abstract is a required field",
		"A PI CV is required for each PI",
		"The Progress Report upload is required",
		"A Primary Field of Science is required",
		"Resources must be requested"
		]
	}
}

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Examples

Validation successful
GET /v1/requests/1158774/actions/12593/validate
{
	"message":"validation successful",
	"result":{
		"validation":"successful",
		"errors":[
		]
	}
}

Validation failure
GET /v1/requests/1162274/actions/13744/validate
{
	"message":"validation failed",
	"result":{
		"validation":"failed",
		"errors":[
		"Title is a required field",
		"Abstract is a required field",
		"A PI CV is required for each PI",
		"The Progress Report upload is required",
		"A Primary Field of Science is required",
		"Resources must be requested"
		]
	}
}

Params

Returns

Code: 200

Description:

OK

Examples

Required Documents calculated successfully
GET v1/requests/1172254/actions/39388/required_documents_status
{
  "message": "required documents retrieval successful",
  "result": [
    {
      "documentTypeId": 2,
      "documentType": "PI CV",
      "displayDocumentType": "PI CV (2 pages limit)",
      "hardPageLimit": 2,
      "allowMany": false,
      "requirementMet": true,
      "message": "Requirement Met"
    },
    {
      "documentTypeId": 3,
      "documentType": "CoPI CV",
      "displayDocumentType": "CoPI CV",
      "hardPageLimit": 2,
      "allowMany": true,
      "requirementMet": false,
      "message": "There must be a CoPI CV document for each CoPI."
    },
    {
      "documentTypeId": 1,
      "documentType": "Main Document",
      "displayDocumentType": "Main Document",
      "hardPageLimit": 15,
      "allowMany": false,
      "requirementMet": true,
      "message": "Requirement Met"
    },
    {
      "documentTypeId": 4,
      "documentType": "Progress Report",
      "displayDocumentType": "Progress Report",
      "hardPageLimit": 3,
      "allowMany": false,
      "requirementMet": true,
      "message": "Requirement Met"
    },
    {
      "documentTypeId": 7,
      "documentType": "Code Perf \u0026 Scaling",
      "displayDocumentType": "Code Perf \u0026 Scaling",
      "hardPageLimit": 5,
      "allowMany": false,
      "requirementMet": true,
      "message": "Requirement Met"
    }
  ]
}

Invalid action failure
GET v1/requests/1172254/actions/393880/required_documents_status
{
  "message": "actionID=393880 not found for this allocations process",
  "result": null
}

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Examples

POST /v1/requests/1/actions/1/documents

This POST can be done in either of two ways: multipart/form-data; or application/json.
NOTE: for application/json, the document must be base64-encoded

========= multipart ==========================================================================

Content-Type:multipart/form-data; boundary=----WebKitFormBoundaryhpbzqiL3Ja9hAV8e
------WebKitFormBoundaryhpbzqiL3Ja9hAV8e
Content-Disposition: form-data; name="documentType"

CV_PI
------WebKitFormBoundaryhpbzqiL3Ja9hAV8e
Content-Disposition: form-data; name="filename"

cv.pdf
------WebKitFormBoundaryhpbzqiL3Ja9hAV8e
Content-Disposition: form-data; name="document"; filename="cv.pdf"
Content-Type: application/pdf


------WebKitFormBoundaryhpbzqiL3Ja9hAV8e
Content-Disposition: form-data; name="title"

My CV
------WebKitFormBoundaryhpbzqiL3Ja9hAV8e--


======== json ===============================================================================

{
  "documentType": "CV_PI",
  "filename": "cv.pdf",
  "title": "My CV",
  "document": <base64-encoded document>
}

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Examples

GET /v1/requests/1/actions/1/documents/1

Response Headers
  Content-Disposition:       attachment; filename="cv.txt"
  Content-Transfer-Encoding: binary
  Content-Type:              text/plain
Response Body
  <cv.txt>


GET /v1/requests/1/actions/2/documents/6

Response Headers
  Content-Disposition:       attachment; filename="cv.pdf"
  Content-Transfer-Encoding: binary
  Content-Type:              application/pdf
Response Body
  <cv.pdf>

Params

Params

Params

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Examples

POST /v1/requests/1/publications

Content-Type: application/json

{
   "id":646,
   "title":"Recipes 2.0: Building for Today and Tomorrow",
   "doi":"",
   "pubMedId":"",
   "bibtex":"",
   "year":2013,
   "month":6,
   "peerReviewed":true,
   "type":{
      "id":1,
      "name":"Conference Paper"
   },
   "abstractText":"The history of science gateway development has, in \nmany ways, been a story of the ?Haves? vs. the ?Have-nots.? \nLarge infrastructure projects led the way, building thick client \nportals to provide coherent interfaces to an incoherent \nenvironment. Contrast this with the way the modern web is \ndesigned using light, front end components and outsourcing \nmuch of the heavy lifting to a mash-up of REST APIs, and it is \neasy to see why modern web applications can be prototyped and \nrefined into stable products in the time it previously took thick \nclient portals to do an initial release. This paper argues that a \n?build for today? philosophy can lead to the rapid development \nof science gateways to serve the ?Have-nots.? Also presented is a \nset of responsive front end components built on top of the iPlant \nFoundation API that provide the boilerplate for rapid \ndevelopment of lightweight science gateways using only HTML, \nJavaScript, and CSS. Using these components, developers can \neasily stand up new gateways or quickly add new functionality to \nexisting ones.",
   "createdBy":"mrhanlon",
   "created":1375215254870,
   "modifiedBy":"mrhanlon",
   "modified":1375215254870,
   "projects":[
      {
         "id":648,
         "projectNumber":"XSEDE_STAFF_PUBLICATION"
      }
   ],
   "authors":[
      {
         "id":3797,
         "author":{
            "id":3855,
            "portalUsername":"mrhanlon",
            "firstName":"Matthew",
            "middleName":"",
            "lastName":"Hanlon",
            "prefix":null,
            "suffix":null,
            "initials":null,
            "affiliation":"Texas Advanced Computing Center",
            "hash":"639829a8eef51574c6412f1a51800adb"
         },
         "order":0
      },
      {
         "id":3798,
         "author":{
            "id":3856,
            "portalUsername":"rdoole1",
            "firstName":"Rion",
            "middleName":"",
            "lastName":"Dooley",
            "prefix":null,
            "suffix":null,
            "initials":null,
            "affiliation":"University of Texas at Austin",
            "hash":"14d985bf3ee796286f62889bbd6099b8"
         },
         "order":1
      }
   ],
   "data":[
      {
         "id":3011,
         "field":{
            "id":1,
            "name":"Conference name",
            "description":"The name of the Conference",
            "type":"textfield",
            "sortOrder":0,
            "required":true,
            "defaultValue":null,
            "options":null
         },
         "value":"5th International Workshop on Science Gateways"
      },
      {
         "id":3012,
         "field":{
            "id":2,
            "name":"Location",
            "description":"The location of the Conference",
            "type":"textfield",
            "sortOrder":1,
            "required":true,
            "defaultValue":null,
            "options":null
         },
         "value":"Zurich, Switzerland"
      },
      {
         "id":3013,
         "field":{
            "id":3,
            "name":"Volume/Issue",
            "description":"",
            "type":"textfield",
            "sortOrder":2,
            "required":false,
            "defaultValue":null,
            "options":null
         },
         "value":"Vol-993"
      },
      {
         "id":3014,
         "field":{
            "id":4,
            "name":"Pages",
            "description":"",
            "type":"textfield",
            "sortOrder":3,
            "required":false,
            "defaultValue":null,
            "options":null
         },
         "value":""
      },
      {
         "id":3015,
         "field":{
            "id":5,
            "name":"URL",
            "description":"",
            "type":"textfield",
            "sortOrder":4,
            "required":false,
            "defaultValue":null,
            "options":null
         },
         "value":"http://ceur-ws.org/Vol-993/paper16.pdf"
      }
   ]
}

Params

Returns

Code: 200

Description:

OK

Params

Returns

Code: 200

Description:

OK

Params