listingEntries
Returns a list of all entries that match the specified entryInternalIds and entryType. You can optionally specify the Entry Type or both the Entry Type and the Internal Ids. Neither value is required.
If the request fails, an error object is returned that includes the "errorCode" fields with one of the values
from the ListingEntryQueryError enum.
If an entry represents a virtual connector, the internalID is shown as <parent connector type>:<virtual connector type>.
Examples:
- For connector "Microsoft Azure SQL Database", the internalID is shown as "database:azuresql"
- For connector "Microsoft Azure SQL Data Warehouse", the internalID is shown as "database:azuredatawarehouse"
For example:
{
"errors": [
{
"message": "You can optionally specify the Entry Type or both the Entry Type and the Internal Ids. Neither value is required.",
"extensions": {
"errorCode": "VALIDATION_ERROR"
}
}
]
}
Query Format:
query{
listingEntries(entryType: <The type of entries being fetched>, entryInternalIds: <Array of internal Ids to fetch>){
}
}
Example Queries:
- A valid request with both the filters specified
query {
listingEntries(entryType: CONNECTOR, entryInternalIds: ["anaplan", "amazons3rest"]){
listingEntryId
name
}}
- A valid request with only the type field specified
query {
listingEntries(entryType: CONNECTOR){
listingEntryId
name
}}
- A valid request with none of the filters specified
query {
listingEntries{
listingEntryId
name
}}
- An invalid request that has only the Internal Ids specified
query {
listingEntries(entryInternalIds: ["anaplan", "amazons3rest"]){
listingEntryId
name
}}
listingEntries(
entryInternalIds: [String]
entryType: ListingEntryType
): [ListingEntry!]!
Arguments
listingEntries.entryInternalIds ● [String] list scalar miscellaneous
listingEntries.entryType ● ListingEntryType enum platform
Type
ListingEntry object platform
Was this topic helpful?