Resources

>>>

GET //v1/resources
get all resources

Also see /v1/resources/<resourceId>.

Examples

GET /v1/resources
{
   "message":null,
   "result":[ <resource> ]
}

Returns

Code: 200

Description:

OK

Param name Description
resourceId
required

Validations:

  • Must be a Integer
resourceName
required

Validations:

  • Must be a String
displayResourceName
required

Validations:

  • Must be a String
description
required

Validations:

  • Must be a String
units
required

Validations:

  • Must be a String
organization
required

Validations:

  • Must be a String
resourceRepositoryKey
required

Validations:

  • Must be a Integer
productionBeginDate
required

Validations:

  • Must be a DateTime
productionEndDate
required

Validations:

  • Must be a DateTime
resourceDescription
required

Validations:

  • Must be a String
recommendedUse
required

Validations:

  • Must be a String
conversionFactor
required

Validations:

  • Must be a Numeric
attributeSets
required

Validations:

  • Must be a Hash
attributeSets[attributeSetId]
required

Validations:

  • Must be a Integer
attributeSets[attributeSetTypeId]
required

Validations:

  • Must be a Integer
attributeSets[attributeSetRelationTypeId]
required

Validations:

  • Must be a Integer
attributeSets[attributeSetName]
required

Validations:

  • Must be a String
attributeSets[attributes]
required

Validations:

  • Must be a Hash
attributeSets[attributes][resourceAttributeId]
required

Validations:

  • Must be a Integer
attributeSets[attributes][attributeName]
required

Validations:

  • Must be a String
attributeSets[attributes][description]
required

Validations:

  • Must be a String
attributeSets[attributes][isRequired]
required

Validations:

  • Must be one of: true, false.
>>>

GET //v1/resources/<resourceId>
get the specified resource

Examples

GET /v1/resources/5
{
   "message":null,
   "result":{
      "resourceId":5,
      "resourceName":"XSEDE ECSS",
      "displayResourceName":"XSEDE Extended Collaborative Support",
      "resourceType":"Program",
      "description":"To request a longer term, focused collaboration with XSEDE staff",
      "units":"Estimated duration of support\nrequired (1-12 months)",
      "organization":"Extreme Science and Engineering Discovery Environment",
      "attributeSets":[
         {
            "attributeSetId":1,
            "attributeSetTypeId":4,
            "attributeSetRelationTypeId":4,
            "attributeSetName":"What do you want to accomplish with the help of expert staff?. Have you already done any work on this aspect of your software?.",
            "attributes":[
               {
                  "resourceAttributeId":1,
                  "attributeName":"Please enter your answer in the provided text area.",
                  "description":"Expertise needed",
                  "isRequired":true
               }
            ]
         },
         {
            "attributeSetId":2,
            "attributeSetTypeId":4,
            "attributeSetRelationTypeId":4,
            "attributeSetName":"How would the success of this collaboration benefit your project?.",
            "attributes":[
               {
                  "resourceAttributeId":2,
                  "attributeName":"Please enter your answer in the provided text area.",
                  "description":"Benefit to the project",
                  "isRequired":true
               }
            ]
         },
         {
            "attributeSetId":3,
            "attributeSetTypeId":4,
            "attributeSetRelationTypeId":4,
            "attributeSetName":"Which member(s) of your team would collaborate with ECSS staff?.",
            "attributes":[
               {
                  "resourceAttributeId":3,
                  "attributeName":"Please enter your answer in the provided text area.",
                  "description":"Collaboration",
                  "isRequired":false
               }
            ]
         }
      ]
   }
}

Params

Param name Description
resourceId
required

The Id of the resource

Validations:

  • Must be a Integer

Returns

Code: 200

Description:

OK

Param name Description
resourceId
required

Validations:

  • Must be a Integer
resourceName
required

Validations:

  • Must be a String
displayResourceName
required

Validations:

  • Must be a String
description
required

Validations:

  • Must be a String
units
required

Validations:

  • Must be a String
organization
required

Validations:

  • Must be a String
resourceRepositoryKey
required

Validations:

  • Must be a Integer
productionBeginDate
required

Validations:

  • Must be a DateTime
productionEndDate
required

Validations:

  • Must be a DateTime
resourceDescription
required

Validations:

  • Must be a String
recommendedUse
required

Validations:

  • Must be a String
conversionFactor
required

Validations:

  • Must be a Numeric
attributeSets
required

Validations:

  • Must be a Hash
attributeSets[attributeSetId]
required

Validations:

  • Must be a Integer
attributeSets[attributeSetTypeId]
required

Validations:

  • Must be a Integer
attributeSets[attributeSetRelationTypeId]
required

Validations:

  • Must be a Integer
attributeSets[attributeSetName]
required

Validations:

  • Must be a String
attributeSets[attributes]
required

Validations:

  • Must be a Hash
attributeSets[attributes][resourceAttributeId]
required

Validations:

  • Must be a Integer
attributeSets[attributes][attributeName]
required

Validations:

  • Must be a String
attributeSets[attributes][description]
required

Validations:

  • Must be a String
attributeSets[attributes][isRequired]
required

Validations:

  • Must be one of: true, false.