Jump to

• Request
• Response
• Examples

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

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.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/Connector"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Connectors"
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

• Array of: object Connector
  Connector

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/Connector"
    }
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : AggregationResult

Type: object

Show Source

• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

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.

{
    "type":"object",
    "properties":{
        "connectorId":{
            "type":"string",
            "description":"Id of the connector. It is a required property in the get response."
        },
        "connectorName":{
            "type":"string",
            "description":"Name of the connector. It is a required property in the get response."
        },
        "connectorType":{
            "type":"string",
            "description":"Type of the connector. It is a required property in the get response."
        },
        "isDigitalContentConnector":{
            "type":"boolean",
            "description":"True for Digital asset connectors, otherwise false",
            "readOnly":true
        },
        "supportedContentTypes":{
            "type":"array",
            "description":"Supported content types of the connector.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Connector"
}

Nested Schema : supportedContentTypes

Type: array

Supported content types of the connector.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Supported content types of the connector.",
    "items":{
        "type":"string"
    }
}

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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

304 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top

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"
          }
        ]
      }

Back to Top