List All Connectors
get
/content/management/api/v1.1/connectors
List all connectors.
Request
Query Parameters
-
limit(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the size of the result.Default Value:
100
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby, first, last, prev, next
-
offset(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the start index of the result.Default Value:
0
-
q(optional): string
This parameter accepts a query expression condition that matches the field values. The value of query condition follows the format of {fieldName} {operator} "{fieldValue}". The only fieldNames allowed for now are name and connectorType and only allowed operators for now are mt on name and eq on connectorType. This query param is optional with no default.
Example:
?q=(name mt "foo")
Example:
?q=(connectorType eq "translation")
Example:
?q=(connectorType eq "content") -
totalResults(optional): boolean
This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.Default Value:
false
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : Connectors
Type:
object
Connectors
Show Source
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
Nested Schema : items
Type:
array
Singular resources contained in the collection.
Show Source
-
Array of:
object Connector
Connector
Nested Schema : links
Type:
array
Links of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : pinned
Type:
array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : Connector
Type:
object
Connector
Show Source
-
connectorId(optional):
string
Id of the connector. It is a required property in the get response.
-
connectorName(optional):
string
Name of the connector. It is a required property in the get response.
-
connectorType(optional):
string
Type of the connector. It is a required property in the get response.
-
isDigitalContentConnector(optional):
boolean
Read Only:
true
True for Digital asset connectors, otherwise false -
supportedContentTypes(optional):
array supportedContentTypes
Supported content types of the connector.
Nested Schema : supportedContentTypes
Type:
array
Supported content types of the connector.
Show Source
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.
Examples
The following example shows how to list all connectors by submission of a GET request on the REST resource using cURL:
curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/connectors'
Example:
This lists all connectors configured in the system.
/content/management/api/v1.1/connectors
Response Body
{ "hasMore": false, "offset": 0, "count": 2, "limit": 2, "items": [ { "connectorId": "10000", "connectorName": "Google Drive", "connectorType": "content", "supportedContentTypes": [] }, { "connectorId": "10002", "connectorName": "Dropbox", "connectorType": "content", "supportedContentTypes": [] } ], "links": [ { "href": "https://<hostname>/content/management/api/v1.1/connectors", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/connectors", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/connectors", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" }, { "href": "https://<hostname>/content/management/api/v1.1/connectors?offset=0", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/connectors?offset=0", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }