Catalogs

Resource Representation ↑

Example:
{
  "id": 1,
  "name": "Catalog Name",
  "data_sets": []
}

Supported Formats

json
>>>

GET /api/v2/catalogs
List catalogs

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

Response:
  {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_entries": 1,
    "entries": [
      {
        "id": 1,
        "name": "Catalog Name",
        "data_sets": []
      }
    ]
  }

Params

Param name Description
per_page
optional

Number of objects in one response. Default is 50

Validations:

  • Must be a number.
page
optional

Page number. Default is 1

Validations:

  • Must be a number.
>>>

POST /api/v2/catalogs
Create an catalog

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
      "catalog": {
          "name": "Catalog Name"
      }
  }

response:
  {
    "id": 2,
    "name": "Catalog Name",
    "data_sets": []
  }

Params

Param name Description
catalog
required

Validations:

  • Must be a Hash
catalog[name]
required

Name of the catalog

Validations:

  • Must be a String
>>>

PUT /api/v2/catalogs/:id
Update an catalog

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
      "catalog": {
          "name": "Catalog Name Updated"
      }
  }

response:
  {
    "id": 2,
    "name": "Catalog Name Updated",
    "data_sets": []
  }

Params

Param name Description
catalog
required

Validations:

  • Must be a Hash
catalog[name]
optional

Name of the catalog

Validations:

  • Must be a String
>>>

DELETE /api/v2/catalogs/:id
Delete an catalog

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

response:
  {
    "id": 2
  }