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

Param name Description
requestId
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