Catalogue restful service

** THIS PAGE IS UNDER CONSTRUCTION **

Catalogue Web Service

Starting from gCube 4.5 a new RESTFul Web Service has been created to let external services/users interact with the D4Science's catalogues. It exploits the underneath CKAN APIs , but at the same time allows to perform operations on the catalogue using the security gCube token.

You are suggested to read the main catalogue wiki page before continue.

Retrieve your gCube Security Token

A security token is a UUID bind to yourself and a given Infrastructure context. To retrieve it, you just need to go to a VRE for which you are interested in retrieving it, and use the Authorisation Options portlet (see below)

Click on Show button and select the token. We will use it later on.

Retrieve web service endpoint

The service endpoint url of the catalogue service depends on the context you are interesting in publishing. You could either access to the Infrastructure Monitor of the Infrastructure and looking for a GCore EndPoint having as name Catalogue-WS and Service Class Data-Catalogue, or perform the same look up operation programmatically with the IC-Client library.

For the development environment, it's value is:

http://catalogue-ws-d-d4s.d4science.org/catalogue-ws/rest

Supported operations

The APIs allow to interact with the catalogue and perform the following operations on it. Please note that they return and accept a JSON object. Be sure to set the following headers in your http requests

Content-type : application/json
Accept: application/json
gcube-token: Token

Please note that the gcube-token can be set into the http header of the request or as query parameter. In the following, we are supposing it has been set in the header.

Licenses

Retrieve the list of licenses (GET)

Return the list of licenses available for datasets on the site.

Example : SERVICE_ENDPOINT/api/licenses/list/

Organizations

Show organization (GET)

Return the details of a organization. Parameters:

• id (boolean) – the id or name of the organization
• include_datasets (boolean) – include a truncated list of the org’s datasets (optional, default: False)
• include_dataset_count (boolean) – include the full package_count (optional, default: True)
• include_extras – include the organization’s extra fields (optional, default: True)
• include_users – include the organization’s users (optional, default: True)
• include_groups – include the organization’s sub groups (optional, default: True)
• include_tags – include the organization’s tags (optional, default: True)
• include_followers – include the organization’s number of followers (optional, default: True)

Path

SERVICE_ENDPOINT/api/organizations/show?id=organization_name

Show organizations list (GET)

Return a list of the names of the site’s organizations. Parameters:

• order_by (string) – the field to sort the list by, must be 'name' or 'packages' (optional, default: 'name') Deprecated use sort.
• sort (string) – sorting of the search results. Optional. Default: “name asc” string of field name and sort-order. The allowed fields are ‘name’, ‘package_count’ and ‘title’
• limit (int) – if given, the list of organizations will be broken into pages of at most limit organizations per page and only one page will be returned at a time (optional)
• offset (int) – when limit is given, the offset to start returning organizations from
• organizations (list of strings) – a list of names of the groups to return, if given only groups whose names are in this list will be returned (optional)
• all_fields (boolean) – return group dictionaries instead of just names. Only core fields are returned - get some more using the include_* options. Returning a list of packages is too expensive, so the packages property for each group is deprecated, but there is a count of the packages in the package_count property. (optional, default: False)
• include_dataset_count (boolean) – if all_fields, include the full package_count (optional, default: True)
• include_extras (boolean) – if all_fields, include the organization extra fields (optional, default: False)
• include_tags (boolean) – if all_fields, include the organization tags (optional, default: False)
• include_groups – if all_fields, include the organizations the organizations are in (optional, default: False)
• include_users (boolean) – if all_fields, include the organization users (optional, default: False).

Path

SERVICE_ENDPOINT/api/organizations/list

Create organization (POST)

Create a new organization.

You must be authorized to create organizations.

Plugins may change the parameters of this function depending on the value of the type parameter, see the IGroupForm plugin interface. Parameters:

• name (string) – the name of the organization, a string between 2 and 100 characters long, containing only lowercase alphanumeric characters, - and _
• id (string) – the id of the organization (optional)
• title (string) – the title of the organization (optional)
• description (string) – the description of the organization (optional)
• image_url (string) – the URL to an image to be displayed on the organization’s page (optional)
• state (string) – the current state of the organization, e.g. 'active' or 'deleted', only active organizations show up in search results and other lists of organizations, this parameter will be ignored if you are not authorized to change the state of the *organization (optional, default: 'active')
• approval_status (string) – (optional)
• extras (list of dataset extra dictionaries) – the organization’s extras (optional), extras are arbitrary (key: value) metadata items that can be added to organizations, each extra dictionary should have keys 'key' (a string), 'value' (a string), and optionally 'deleted'
• packages (list of dictionaries) – the datasets (packages) that belong to the organization, a list of dictionaries each with keys 'name' (string, the id or name of the dataset) and optionally 'title' (string, the title of the dataset)
• users (list of dictionaries) – the users that belong to the organization, a list of dictionaries each with key 'name' (string, the id or name of the user) and optionally 'capacity' (string, the capacity in which the user is a member of the organization)

Returns:

the newly created organization (unless ‘return_id_only’ is set to True in the context, in which case just the organization id will be returned)

Path

SERVICE_ENDPOINT/api/organizations/create

Update organization (POST)

Update a organization.

You must be authorized to edit the organization. For further parameters see organization create.

Parameters:

• id (string) – the name or id of the organization to update

Path

SERVICE_ENDPOINT/api/organizations/update

Patch organization (POST)

Patch an organization

Parameters: id (string) – the id or name of the organization The difference between the update and patch methods is that the patch will perform an update of the provided parameters, while leaving all other parameters unchanged, whereas the update methods deletes all parameters not explicitly provided in the data_dict

Path

SERVICE_ENDPOINT/api/organizations/patch

Delete organization (DELETE)

Delete an organization.

You must be authorized to delete the organization.

Parameters:

• id (string) – the name or id of the organization

Path

SERVICE_ENDPOINT/api/organizations/delete/

Purge organization (DELETE)

Purging an organization completely removes the organization from the catalogue, whereas deleting an organization simply marks the organization as deleted (it will no longer show up in the frontend, but is still in the db).

Datasets owned by the organization will remain, just not in an organization any more.

You must be authorized to purge the organization.

Parameters:

• id (string) – the name or id of the organization to be purged

Path

SERVICE_ENDPOINT/api/organizations/purge/

Groups

Group show (GET)

Return the details of a group.

Parameters:

• id (boolean) – the id or name of the group
• include_datasets (boolean) – include a truncated list of the group’s datasets (optional, default: False)
• include_dataset_count (boolean) – include the full package_count (optional, default: True)
• include_extras – include the group’s extra fields (optional, default: True)
• include_users – include the group’s users (optional, default: True)
• include_groups – include the group’s sub groups (optional, default: True)
• include_tags – include the group’s tags (optional, default: True)
• include_followers – include the group’s number of followers (optional, default: True)

Path

SERVICE_ENDPOINT/api/groups/show?id=group_name

Groups list (GET)

Return a list of the names of the site’s groups.

Parameters:

• order_by (string) – the field to sort the list by, must be 'name' or 'packages' (optional, default: 'name') Deprecated use sort.
• sort (string) – sorting of the search results. Optional. Default: “name asc” string of field name and sort-order. The allowed fields are ‘name’, ‘package_count’ and ‘title’
• limit (int) – if given, the list of groups will be broken into pages of at most limit groups per page and only one page will be returned at a time (optional)
• offset (int) – when limit is given, the offset to start returning groups from
• groups (list of strings) – a list of names of the groups to return, if given only groups whose names are in this list will be returned (optional)
• all_fields (boolean) – return group dictionaries instead of just names. Only core fields are returned - get some more using the include_* options. Returning a list of packages is too expensive, so the packages property for each group is deprecated, but there is a count of the packages in the package_count property. (optional, default: False)
• include_dataset_count (boolean) – if all_fields, include the full package_count (optional, default: True)
• include_extras (boolean) – if all_fields, include the group extra fields (optional, default: False)
• include_tags (boolean) – if all_fields, include the group tags (optional, default: False)
• include_groups (boolean) – if all_fields, include the groups the groups are in (optional, default: False).
• include_users (boolean) – if all_fields, include the group users (optional, default: False).

Path

SERVICE_ENDPOINT/api/groups/list

Group create (POST)

Create a new group.

You must be authorized to create groups.

Parameters:

• name (string) – the name of the group, a string between 2 and 100 characters long, containing only lowercase alphanumeric characters, - and _
• id (string) – the id of the group (optional)
• title (string) – the title of the group (optional)
• description (string) – the description of the group (optional)
• image_url (string) – the URL to an image to be displayed on the group’s page (optional)
• type (string) – the type of the group (optional), IGroupForm plugins associate themselves with different group types and provide custom group handling behaviour for these types Cannot be ‘organization’
• state (string) – the current state of the group, e.g. 'active' or 'deleted', only active groups show up in search results and other lists of groups, this parameter will be ignored if you are not authorized to change the state of the group (optional, default: 'active')
• approval_status (string) – (optional)
• extras (list of dataset extra dictionaries) – the group’s extras (optional), extras are arbitrary (key: value) metadata items that can be added to groups, each extra dictionary should have keys 'key' (a string), 'value' (a string), and optionally 'deleted'
• packages (list of dictionaries) – the datasets (packages) that belong to the group, a list of dictionaries each with keys 'name' (string, the id or name of the dataset) and optionally 'title' (string, the title of the dataset)
• groups (list of dictionaries) – the groups that belong to the group, a list of dictionaries each with key 'name' (string, the id or name of the group) and optionally 'capacity' (string, the capacity in which the group is a member of the group)
• users (list of dictionaries) – the users that belong to the group, a list of dictionaries each with key 'name' (string, the id or name of the user) and optionally 'capacity' (string, the capacity in which the user is a member of the group)

Returns: the newly created group (unless ‘return_id_only’ is set to True in the context, in which case just the group id will be returned) Path

SERVICE_ENDPOINT/api/groups/create/

Group delete (DELETE)

Delete a group.

You must be authorized to delete the group.

Parameters:

• id (string) – the name or id of the group

Path

SERVICE_ENDPOINT/api/groups/create/

Group purge (DELETE)

Purge a group.

Purging a group cannot be undone! Purging a group completely removes the group from the catalogue, whereas deleting a group simply marks the group as deleted (it will no longer show up in the frontend, but is still in the db).

Datasets in the organization will remain, just not in the purged group.

You must be authorized to purge the group.

Parameters:

• id (string) – the name or id of the group to be purged

Path

SERVICE_ENDPOINT/api/groups/purge/

Group update (POST)

Update a group.

You must be authorized to edit the group.

For further parameters see group create.

Parameters:

• id (string) – the name or id of the group to update

Path

SERVICE_ENDPOINT/api/groups/update/

Group patch (POST)

Patch a group

Parameters:

• id (string) – the id or name of the group

The difference between the update and patch methods is that the patch will perform an update of the provided parameters, while leaving all other parameters unchanged, whereas the update methods deletes all parameters not explicitly provided in the data_dict

Path

SERVICE_ENDPOINT/api/groups/patch/