Help Search

Edit on github

View one resource

It is possible to get data for a single resource identified by the unique UUID. All you need is to make a GET request to /resources/.json.

GET /resources/<resourceId>.json

Possible responses

Code Description
200 OK
Response includes the resource metadata object.
400 Bad Request
The resourceId supplied is not a valid UUID
403 Authentication Failure
The user making the request is not authenticated
404 Not Found
The resource either does not exist or the user does not have access permission.

Examples

Success response

{
  "header": {
    "id": "bc8a85a7-bde8-48d5-8749-827c9185db15",
    "status": "success",
    "servertime": 1554907370,
    "action": "83bb8bd8-2006-5546-a3bb-9319ae6e8f9d",
    "message": "The operation was successful.",
    "url": "/resources/ecf0ed85-3bfc-5f45-b11d-74e9a86aa313.json",
    "code": 200
  },
  "body": {
    "id": "ecf0ed85-3bfc-5f45-b11d-74e9a86aa313",
    "name": "Grogle",
    "username": "grogleusername",
    "uri": "http://fr.groland.wikia.com/wiki/Grogle",
    "description": "",
    "deleted": false,
    "resource_type_id": "e2aa01a9-84ec-55f8-aaed-24ee23259339",
    "created": "2019-04-04T12:05:58+00:00",
    "modified": "2019-04-08T09:16:09+00:00",
    "created_by": "f848277c-5398-58f8-a82a-72397af2d450",
    "modified_by": "f848277c-5398-58f8-a82a-72397af2d450"
  }
}

Last updated

This article was last updated on April 23rd, 2019.

For another perspective on the API you browse the OpenAPI 2.0 specifications using the dedicated API reference site (Swagger UI).

API Reference

You can also find the latest OpenAPI 2.0 specifications directly on the dedicated repository.

OpenAPI Specs repository