API Reference

List federated sources

GET/api/gotham/v1/federatedSources

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Get a list of all federated sources.

Query parameters

preview

boolean

optional

Represents a boolean value that restricts an endpoint to preview mode when set to true.

Response body

GetFederatedSourceResponse

object

A list of federated sources.

Hide children

nextPageToken

string

optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and populate the next request's pageToken field with it.

data

list<FederatedSource>

optional

Show children

FederatedSource

object

Represents a federated source that is available for use in the system.

Show children

name

string

The name of a federated source.

displayName

string

optional

The display name of the federated source.

namespaces

list<Namespace>

optional

The namespaces of the federated source.

Show children

Namespace

object

Represents a namespace of a federated source.

Show children

name

string

A identity/name of a namespace of a federated source.

displayName

string

The properties of a namespace of a federated source.

queryShape

union

optional

Show children

not

object

optional

Returns objects where the query is not satisfied.

Show children

value

union

Show children

not

object

optional

Returns objects where the query is not satisfied.

Show children

value

union

object

optional

Returns objects where at least 1 query is satisfied.

Show children

value

list<FederatedSearchJsonQuery>

optional

Show children

FederatedSearchJsonQuery

union

and

object

optional

Returns objects where every query is satisfied.

Show children

value

list<FederatedSearchJsonQuery>

optional

Show children

FederatedSearchJsonQuery

union

term

object

optional

Returns objects where the specified field matches the value. The exact kind of matching depends on the data source.

Show children

field

string

value

any

Represents the value of a property. The following table provides expected representations of scalar data types:

Type	JSON encoding	Example
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Integer	number	`238940`
Long	string	`"58319870951433"`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

object

optional

Returns objects where at least 1 query is satisfied.

Show children

value

list<FederatedSearchJsonQuery>

optional

Show children

FederatedSearchJsonQuery

union

Show children

not

object

optional

Returns objects where the query is not satisfied.

Show children

value

union

object

optional

Returns objects where at least 1 query is satisfied.

Show children

value

list<FederatedSearchJsonQuery>

optional

Show children

FederatedSearchJsonQuery

union

and

object

optional

Returns objects where every query is satisfied.

Show children

value

list<FederatedSearchJsonQuery>

optional

Show children

FederatedSearchJsonQuery

union

term

object

optional

Returns objects where the specified field matches the value. The exact kind of matching depends on the data source.

Show children

field

string

value

any

Represents the value of a property. The following table provides expected representations of scalar data types:

Type	JSON encoding	Example
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Integer	number	`238940`
Long	string	`"58319870951433"`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

and

object

optional

Returns objects where every query is satisfied.

Show children

value

list<FederatedSearchJsonQuery>

optional

Show children

FederatedSearchJsonQuery

union

Show children

not

object

optional

Returns objects where the query is not satisfied.

Show children

value

union

object

optional

Returns objects where at least 1 query is satisfied.

Show children

value

list<FederatedSearchJsonQuery>

optional

Show children

FederatedSearchJsonQuery

union

and

object

optional

Returns objects where every query is satisfied.

Show children

value

list<FederatedSearchJsonQuery>

optional

Show children

FederatedSearchJsonQuery

union

term

object

optional

Returns objects where the specified field matches the value. The exact kind of matching depends on the data source.

Show children

field

string

value

any

Represents the value of a property. The following table provides expected representations of scalar data types:

Type	JSON encoding	Example
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Integer	number	`238940`
Long	string	`"58319870951433"`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

term

object

optional

Returns objects where the specified field matches the value. The exact kind of matching depends on the data source.

Show children

field

string

value

any

Represents the value of a property. The following table provides expected representations of scalar data types:

Type	JSON encoding	Example
Date	ISO 8601 extended local date string	`"2021-05-01"`
Decimal	string	`"2.718281828"`
Double	number	`3.14159265`
Integer	number	`238940`
Long	string	`"58319870951433"`
String	string	`"Call me Ishmael"`
Timestamp	ISO 8601 extended offset date-time string in UTC zone	`"2021-01-04T05:00:00Z"`

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/gotham/v1/federatedSources?preview=true"

Response

Copied!

[
  {
    "name": "My Federated Source"
  },
  {
    "name": "My Other Federated Source"
  }
]