Get a Graph - Cognigy Documentation

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Headers

enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

projectId

string

required

The unique identifier for the Project.

Required string length: 24

Pattern: ^[a-z0-9]{24}$

Query Parameters

snapshots

enum<string>

default:false

If set to true, Snapshot resources are included in the graph. The default value is false.

Available options:

false,

true

packages

enum<string>

default:false

If set to true, Package resources are included in the graph. The default value is false.

Available options:

false,

true

dependencies

enum<string>

default:false

If set to true, dependency relationships are included in the graph. The default value is false.

Available options:

false,

true

Response

Project graph retrieved.

{key}

object

Show child attributes