Named Query Daedalus

Request to execute a predefined named query to Daedalus

Sends a predefined GraphQL query to Daedalus for a specific catalog. If not catalog_id is sent as query param then the first private catalog of the org is picked by default

Request

URI

POST

https://api.app-catalog.vmware.com/v1/daedalus/queries

COPY

Query Parameters

CatalogId

catalog_id

Optional

A string as the identifier of a catalog

Request Body

It contains the query name and variables to send to daedalus

DaedalusNamedQueryRequest of type(s) application/json

Required

Show optional properties

{
    "query_name": "PACKAGES"
}

{
    "query_name": "PACKAGES",
    "variables": {}
}

string

query_name

Required

Name of the named query

object

variables

Optional

variables

Authentication

This operation uses the following authentication methods.

BearerAuth

Responses

200

Daedalus response

Returns string of type(s) application/json

Operation doesn't return any data structure

400

An error related to the request

Returns ConstraintsViolationsError of type(s) application/problem+json

This response body class contains all of the following: InlineConstraintsViolationsError0

{
    "type": "https://example.com/probs/validation-error",
    "title": "Validation error",
    "status": 400,
    "detail": "There was an error validating the request",
    "violations": [
        {
            "field": "amount",
            "message": "It should be greater than zero"
        }
    ]
}

array of object

violations

Required

It represents a constraints violation error

403

The requesting user is not authorized to query Daedalus

Returns Error403 of type(s) application/problem+json

This response body class contains all of the following: InlineError4030

{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

404

The catalog is not found

Returns Error404 of type(s) application/problem+json

This response body class contains all of the following: InlineError4040

{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

500

An internal server error object

Returns Error500 of type(s) application/problem+json

This response body class contains all of the following: InlineError5000

{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

503

The server is temporarily unavailable

Returns Error503 of type(s) application/problem+json

This response body class contains all of the following: InlineError5030

{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"query_name:"string"}' https://{api_host}/v1/daedalus/queries

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Daedalus Operations