External Sources are sources of metadata to be imported into the Waterline Data catalog. Endpoints under
/externalsource
provide a way to identify and connect to these outside applications. For example,
the extensions created to import metadata from applications such as Apache Atlas or Cloudera Navigator use
external sources to persist connection information for the application instance.
External source calls are available only to users with administrator roles.
A GET request to the /externalsource
endpoint retrieves a list of External Sources.
media type | data type | description |
---|---|---|
application/json | IterableOfExternalSource (JSON) | An iterable list of External Source objects in JSON format. |
GET /v2/externalsource
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{ }
A POST request to the /externalsource
endpoint creates a new ExternalSource.
media type | data type | description |
---|---|---|
application/json | ExternalSource (JSON) | A JSON object with the initial property-value pairs for the new external source. |
media type | data type | description |
---|---|---|
application/json | ExternalSource (JSON) | The new ExternalSource object with its assigned unique identifying key. |
POST /v2/externalsource
Content-Type: application/json
Accept: application/json
{
"sourceName" : "...",
"attributes" : {
"property1" : { },
"property2" : { }
},
"sourceType" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"sourceName" : "...",
"attributes" : {
"property1" : { },
"property2" : { }
},
"sourceType" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
A DELETE request to the /externalsource/{key}
endpoint removes an existing ExternalSource from the system.
name | type | description |
---|---|---|
key | path | The unique key of the external source. |
DELETE /v2/externalsource/{key}
Content-Type: */*
...
HTTP/1.1 204 No Content
A GET request to the /externalsource/{key}
endpoint retrieves an external source.
name | type | description |
---|---|---|
key | path | The unique key of the external source. |
media type | data type | description |
---|---|---|
application/json | ExternalSource (JSON) | The ExternalSource object, in JSON format. |
GET /v2/externalsource/{key}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"sourceName" : "...",
"attributes" : {
"property1" : { },
"property2" : { }
},
"sourceType" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
A DELETE request to the /externalsource/name/{name}
endpoint removes an existing ExternalSource from the system.
name | type | description |
---|---|---|
name | path | The external source name, its "sourceName" property. |
DELETE /v2/externalsource/name/{name}
Content-Type: */*
...
HTTP/1.1 204 No Content
A GET request to the /externalsource/name/{name}
endpoint retrieves an external source.
name | type | description |
---|---|---|
name | path | The external source name, its "sourceName" property. |
media type | data type | description |
---|---|---|
application/json | ExternalSource (JSON) | The ExternalSource object, in JSON format. |
GET /v2/externalsource/name/{name}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"sourceName" : "...",
"attributes" : {
"property1" : { },
"property2" : { }
},
"sourceType" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}