URI
<datacatalog_uri>/relationship[.<format>]
Supported methods
Parent resource
Child resources
Introduction
The relationship resource represents the relational datasource. It can access the dataset set registered by Data Store and get the entry of the dataset importing operation.
Supported Methods:
- GET: Get the dataset set and the entry of the dataset importing operation.
- HEAD: Check whether the relationship resource exists, or whether to have authority to access the relationship resource.
Supported output formats: rjson, json, html, xml.
Resource hierarchy
HTTP request methods
Implement the HTTP request on the following URI, where supermapiserver is the server name, with rjson being the output format.
http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/relationship.rjson
GET request
Get the dataset set and the entry of the dataset importing operation.
Response structure
GET request in relationship resource is a resource descriptive collection in the entity of response messaging, where the structure of a single resource description is as follows:
Field | Type | Description |
name | String | The resource name. |
path | String | Resource URL. |
resourceConfigID | String | The configuration item ID of the resource. |
resourceType | String | The resource type. |
supportedMediaTypes | String[] | The media-type of the supported representation. |
Response example
The returned rjson format representation after implementing the GET request on the relationship resource is as follows:
[
{
"name": "datasetsimport",
"path": "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/relationship/datasetsimport",
"resourceConfigID": "datasetsimport",
"resourceType": null,
"supportedMediaTypes": null
},
{
"name": "datasets",
"path": "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/relationship/datasets",
"resourceConfigID": "datasets",
"resourceType": null,
"supportedMediaTypes": null
}
]
HEAD request
Returns the same HTTP response header as the GET request, but does not have the response entity. It can get the metadata information in the response header without transferring the whole response content. Metadata information includes media type, character encoding, compression encoding, entity content length, and so on.
The HEAD request can be used to determine whether the relationship resource exists or whether the client has authority to access the relationship resource. It can quickly determine whether the relationship resource supports the representation in <format> format by performing HEAD request on URI with <format>.