GET resource/get-resource?resource_id={resource_id}&community_short_name={community_short_name}

Get a specific resource by its own identifier and community short name where it belongs.

Request Information

Headers

HTTP_AUTHORIZATION: Required. OAuth 1.0 parameters with the OAuth signature of the url you are going to request. The consumer keys and access token can be obtained from the community administration.

Sample:

        HTTP_AUTHORIZATION:
            OAuth oauth_token="CObXqjfOisVh9%2F2GjC7NNd8BCzY%3D",
            oauth_consumer_key="clGACsiGaMp%2FD%2BUwkSvRBxA1k50%3D",
            oauth_nonce="VqKza6d5x1HpPQWFe08spbdOnkTQpfaLfD9Oeuyg",
            oauth_signature_method="HMAC-SHA1",
            oauth_timestamp="1462882011",
            oauth_signature="RH5aKKKJaEvK5cIsZZzXtFh7cCk%3D"

URI Parameters

Name	Description	Type	Additional information
resource_id	Resource identifier	globally unique identifier	Required
community_short_name	Community short name	string	Required

Response Information

Resource Description

Name	Description	Type	Additional information
community_short_name	Community short name	string	Optional
resource_id	Resource identifier	globally unique identifier	Optional
title	Resource title	string	Optional
description	Resource description	string	Optional
tags	Resource tags	Collection of string	Optional
categories	Resource categories	Collection of globally unique identifier	Optional
resource_type	Resource type	integer	Optional
resource_url	Resource url	string	Optional
ontology	Ontology	string	Optional
resource_attached_files	Resource attached files	Collection of AttachedResource	Optional
authors	Resource authors (comma separated)	string	Optional
url_screenshot	Url to make a screenshot	string	Optional
predicate_screenshot	Screenshot predicate	string	Optional
screenshot_sizes	Screenshot posible sizes	Collection of integer	Optional
visibility	Resource visibility enumeration	integer	Optional
readers_list	Resource readers list	Collection of ReaderEditor	Optional
editors_list	Resource editors list	Collection of ReaderEditor	Optional
creation_date	Resource creation date	date	Optional
main_image	Path of the resource main image	string	Optional
lecturaAumentada		AumentedReading	Optional
link		string	Optional

Response Formats

application/json, text/json

Sample:

{
  "community_short_name": "sample string 1",
  "resource_id": "f2deacd8-4afa-44e6-ac10-b41862bda336",
  "title": "sample string 3",
  "description": "sample string 4",
  "tags": [
    "sample string 1",
    "sample string 2"
  ],
  "categories": [
    "70dcfc20-088d-4a9e-9d12-2a2627b0d499",
    "4f5ed703-a404-4bda-83a5-4fe7fb921320"
  ],
  "resource_type": 5,
  "resource_url": "sample string 6",
  "ontology": "sample string 7",
  "resource_attached_files": [
    {
      "file_rdf_property": "sample string 1",
      "file_property_type": 2,
      "rdf_attached_file": "QEA=",
      "delete_file": true
    },
    {
      "file_rdf_property": "sample string 1",
      "file_property_type": 2,
      "rdf_attached_file": "QEA=",
      "delete_file": true
    }
  ],
  "authors": "sample string 8",
  "url_screenshot": "sample string 9",
  "predicate_screenshot": "sample string 10",
  "screenshot_sizes": [
    1,
    2
  ],
  "visibility": 11,
  "readers_list": [
    {
      "user_id": "5ea9fe2a-342e-41c9-aec6-e95aed680667",
      "user_short_name": "sample string 2",
      "group_short_name": "sample string 3",
      "organization_short_name": "sample string 4"
    },
    {
      "user_id": "5ea9fe2a-342e-41c9-aec6-e95aed680667",
      "user_short_name": "sample string 2",
      "group_short_name": "sample string 3",
      "organization_short_name": "sample string 4"
    }
  ],
  "editors_list": [
    {
      "user_id": "5ea9fe2a-342e-41c9-aec6-e95aed680667",
      "user_short_name": "sample string 2",
      "group_short_name": "sample string 3",
      "organization_short_name": "sample string 4"
    },
    {
      "user_id": "5ea9fe2a-342e-41c9-aec6-e95aed680667",
      "user_short_name": "sample string 2",
      "group_short_name": "sample string 3",
      "organization_short_name": "sample string 4"
    }
  ],
  "creation_date": "2024-11-21T22:09:53.7065415+01:00",
  "main_image": "sample string 12",
  "lecturaAumentada": {
    "title": "sample string 1",
    "description": "sample string 2"
  },
  "link": "sample string 13"
}

Response HTTP status code

On success, the response contains 200 code.

On fail, throws a WebException with code:

401 Unauthorized if the OAuth signature is invalid
400 Bad Request if the params are invalid
500 Internal server error if something goes wrong...