API docs by Redocly

Altair Graph Studio REST API (6.2.0)

Download OpenAPI specification:

URL: https://web.altair.com/support-contact

Altair Graph Studio REST API

graphmarts

Graphmarts Operations

Retrieves all graphmarts

This request returns the title, type, and URI for all graphmarts the user has permission to view. When expand=* is specified in the request, details about tags, layers, created and modified dates, and non-default graphmart configuration settings are also retrieved.

Authorizations:
basicAuth
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[]

Creates a new graphmart

This request is used to create and configure a new graphmart. Title is the only required parameter.

Authorizations:
basicAuth
Request Body schema: application/json

Configuration details for the new graphmart.

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Returns information about a graphmart

This request retrieves the title, type, and URI for a graphmart. When expand=* is specified in the request, details about tags, layers, created and modified dates, and non-default graphmart configuration settings are also retrieved.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

Responses

Response samples

Content type
application/json
{
  • "title": "Example Graphmart"
}

Creates or replaces a graphmart

This request replaces an existing graphmart or creates a new one with the specified URI.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
query Parameters
force
required
boolean
Default: false

Controls whether to accept confirmation and force the replacement of any existing children when you specify an existing graphmart URI in the request. If false (the default value), an error is returned if you reference an existing graphmart URI without including the child layers in the request. The error acts as a warning to inform you that existing children will be deleted if you proceed. To force the removal of existing layers, include force=true.

Request Body schema: application/json

The Graphmart you'd like to replace or create

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Modifies a graphmart

This request updates configuration properties for the specified graphmart. PATCH requests do not require any specific body parameters. However, if the request does include any of the parameters that are denoted as required in the schema below, their values cannot be null.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
Request Body schema: application/json

The Graphmart you'd like to modify

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Deletes a graphmart

This request deletes the specified graphmart, including all of the data layers, steps, and graph data.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
query Parameters
force
required
boolean
Default: false

Controls if graphmart will be deleted where confirmation is required. If false (the default value), the confirmation message is returned. To force the removal of graphmart, include force=true.

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Returns the status of a graphmart

This request returns the status of the specified graphmart (i.e., Offline, Online, Activating, etc), the activation timestamp, and the duration of the activation. If detail=true, the request returns the entire GraphmartStatus object, including layer statuses, step counts, total statements, last accessed timestamp, etc.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
query Parameters
detail
boolean

Whether to show detailed status information

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Activates a graphmart

This request asynchronously activates the specified graphmart. The request returns an error if the graphmart is currently activating, deactivating, or refreshing. If the graphmart is already active, the graphmart is deactivated and then activated again. One of 'azgLaunchConfiguration' or 'staticAzgServer' is required unless there is exactly one static AZG server registered in the system. 'elasticLaunchConfiguration' is required when 'azgLaunchConfiguration' is present and the graphmart contains datasets with Elasticsearch indexes.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
Request Body schema: application/json

Activate Graphmart Request Body

object (AzgActivationLaunchConfiguration)
object (ElasticActivationLaunchConfiguration)
object (GraphmartRunConfiguration)
staticAzgServer
string

the URI of the static Lakehouse

Responses

Request samples

Content type
application/json
{
  • "azgLaunchConfiguration": {
    },
  • "elasticLaunchConfiguration": {
    },
  • "graphmartRunConfiguration": {
    },
  • "staticAzgServer": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Deactivates a graphmart

This request asynchronously deactivates the specified graphmart. The data is deleted from Lakehouse and the graphmart’s status is changed to Offline. This request returns an error if the graphmart is currently activating, deactivating, offline, or refreshing.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Refreshes a graphmart

This request asynchronously refreshes the specified graphmart. A refresh reloads any graphmart configuration changes or “dirty” data layers without reloading layers that have not changed. This request returns an error if the graphmart is currently activating, deactivating, offline, or refreshing.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Reloads a graphmart

This request asynchronously reloads the specified graphmart. A reload unloads all data layers (regardless of whether the layers have changed) and then loads them again. This request returns an error if the graphmart is currently activating, deactivating, offline, or refreshing.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
Request Body schema: application/json

Reload Graphmart Request Body

deployOnActivation
boolean

Whether to Deploy Data To Lakehouse During Activation

runConfiguration
string

URI of Run Configuration for layers and steps which should be enabled during deploy/reload/refresh

inDesignMode
boolean

Whether the Grapmart is deployed in Design Mode

runAsPipeline
boolean

When deployed with this Run Configuration, the Graphmart will automatically return to an OFFLINE state after all of its layers are done processing.

Responses

Request samples

Content type
application/json
{
  • "deployOnActivation": true,
  • "runConfiguration": "string",
  • "inDesignMode": true,
  • "runAsPipeline": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Retrieves all layers in a graphmart

This request returns details about the data layers in the specified graphmart.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds a layer to a graphmart

This request adds a layer to the specified graphmart.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
Request Body schema: application/json
title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Replaces all layers in a graphmart

This request replaces all layers in the specified graphmart.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
query Parameters
force
required
boolean
Default: false

If true, any existing children not specified in the PUT request will be deleted. If false, an error will be thrown.

Request Body schema: application/json
Array
title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Deletes all layers in a graphmart

This request deletes all layers from the specified graphmart, including all of the steps and graph data.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Removes a layer from a graphmart

This request deletes the specified data layer from a graphmart, including all of the steps and graph data.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
layer_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Creates or replaces a layer

This request replaces an existing layer or creates a new one with the specified URI.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
layer_uri
required
string
query Parameters
force
required
boolean
Default: false

If true, any existing children not specified in the PUT request will be deleted. If false, an error will be thrown.

Request Body schema: application/json

The layer to replace or create

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Moves a layer within a graphmart

This request moves a layer to another position within the graphmart's layer collection.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
layer_uri
required
string
query Parameters
after
string
before
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Retrieves all run configurations in a graphmart

This request returns details about the run configurations in the specified graphmart.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds a run configuration to a graphmart

This request adds a layer to the specified graphmart.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
Request Body schema: application/json
title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Replaces all run configs in a graphmart

This request replaces all run configs in the specified graphmart.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
query Parameters
force
required
boolean
Default: false

If true, any existing children not specified in the PUT request will be deleted. If false, an error will be thrown.

Request Body schema: application/json
Array
title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Deletes all run configs in a graphmart

This request deletes all run configs from the specified graphmart.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Removes a run config from a graphmart

This request deletes the specified run configuration from a graphmart.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
runconfig_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Creates or replaces a run config

This request replaces an existing run config or creates a new one with the specified URI.

Authorizations:
basicAuth
path Parameters
graphmart_uri
required
string
runconfig_uri
required
string
Request Body schema: application/json

The run config to replace or create

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Refreshes a set of layers

This request asynchronously refreshes the specified layers. The layers parameter can be specified as a comma-separated list of URIs, such as '…layers/refresh?layers=http%3A%2F%2Fcambridgesemantics.com%2FLayer%2Fad231d34-f28c-4f71-bf67-b004577292ae,http%3A%2F%2Fcambridgesemantics.com%2FLayer%2F63310e50a1f04c90874b1a53d229ab1e' or you can include multiple layers parameters, such as '…/layers/refresh?layers=http%3A%2F%2Fcambridgesemantics.com%2FLayer%2Fad231d34-f28c-4f71-bf67-b004577292ae&layers=http%3A%2F%2Fcambridgesemantics.com%2FLayer%2F63310e50a1f04c90874b1a53d229ab1e'. The request returns an error if the parent graphmart is currently activating, deactivating, offline, or refreshing.

Authorizations:
basicAuth
query Parameters
layers
required
Array of strings >= 1

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Retrieves a layer

This request retrieves the title, type, URI, and enabled status for the specified layer. When expand=* is specified in the request, details about steps, created and modified dates, and non-default layer configuration properties are also retrieved.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

Responses

Response samples

Content type
application/json
{
  • "title": "Example Layer"
}

Modifies a layer

This request updates the configuration properties for the specified layer. PATCH requests do not require any specific body parameters. However, if the request does include any of the parameters that are denoted as required in the schema below, their values cannot be null.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string
Request Body schema: application/json

The Layer you'd like to modify

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Deletes a layer

This request deletes the specified layer, including all steps and graph data.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Retrieves the status of a layer

This request returns the type, status, and status text for the specified layer.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string
query Parameters
detail
boolean

Whether to show detailed status information

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Returns details about the steps in a layer

This request retrieves the type, title, URI, description, enabled status, ontology, and source information for the steps in the specified layer. When expand=* is specified, details such as the created date, creator, and modifier are retrieved as well as the transformation query run by each step. See Step Type Schemas for supported step types and their properties.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[]

Creates a new step

This request creates a new step in the specified layer. See Step Type Schemas for supported step types and their properties.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string
Request Body schema: application/json

The step to add

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Replaces all steps in a layer

This request replaces all steps in the specified layer. See Step Type Schemas for supported step types and their properties.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string
query Parameters
force
required
boolean
Default: false

If true, any existing children not specified in the PUT request will be deleted. If false, an error will be thrown.

Request Body schema: application/json
Array
title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[]

Deletes all steps in a layer

This request deletes all steps from the specified layer. Graph data associated with the steps is also deleted.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Deletes a step in a layer

This request deletes the specified step from the given layer. Graph data associated with the step is also deleted.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string
step_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Creates or replaces a step

This request replaces an existing step or creates a new one with the specified URI. See Step Type Schemas for supported step types and their properties.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string
step_uri
required
string
query Parameters
force
required
boolean
Default: false

If true, any existing children not specified in the PUT request will be deleted. If false, an error will be thrown.

Request Body schema: application/json

The Step you'd like to replace or create

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Returns details about the views in a layer

This request retrieves the type, title, URI, description, enabled status, ontology, and source information for the views in the specified layer. When expand=* is specified, details such as the created date, creator, and modifier are retrieved as well as the transformation query run by each view. See View Type Schemas for supported view types and their properties.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new view

This request creates a new view in the specified layer. See View Type Schemas for supported view types and their properties.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string
Request Body schema: application/json

The view to add

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Replaces all views in a layer

This request replaces all views in the specified layer. See View Type Schemas for supported view types and their properties.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string
query Parameters
force
required
boolean
Default: false

If true, any existing children not specified in the PUT request will be deleted. If false, an error will be thrown.

Request Body schema: application/json
Array
title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Deletes all views in a layer

This request deletes all views from the specified layer. Graph data associated with the views is also deleted.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Deletes a view in a layer

This request deletes the specified view from the given layer. Graph data associated with the view is also deleted.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string
view_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Creates or replaces a view

This request replaces an existing view or creates a new one with the specified URI. See View Type Schemas for supported view types and their properties.

Authorizations:
basicAuth
path Parameters
layer_uri
required
string
view_uri
required
string
query Parameters
force
required
boolean
Default: false

If true, any existing children not specified in the PUT request will be deleted. If false, an error will be thrown.

Request Body schema: application/json

The View you'd like to replace or create

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Retrieves a step

This request returns information about the specified step. See Step Type Schemas for supported step types and their properties.

Authorizations:
basicAuth
path Parameters
step_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

Responses

Response samples

Content type
application/json
{
  • "title": "Example Step"
}

Modifies a step

This request updates the configuration properties for the specified step. PATCH requests do not require any specific body parameters. However, if the request does include any of the parameters that are denoted as required in the schema below, their values cannot be null. See Step Type Schemas for supported step types and their properties.

Authorizations:
basicAuth
path Parameters
step_uri
required
string
Request Body schema: application/json

The Step you'd like to modify

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Deletes a step

This request deletes the specified step, including all graph data.

Authorizations:
basicAuth
path Parameters
step_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Retrieves a view

This request returns information about the specified view. See View Type Schemas for supported view types and their properties.

Authorizations:
basicAuth
path Parameters
view_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

Responses

Response samples

Content type
application/json
{
  • "title": "Example View"
}

Modifies a view

This request updates the configuration properties for the specified view. PATCH requests do not require any specific body parameters. However, if the request does include any of the parameters that are denoted as required in the schema below, their values cannot be null. See View Type Schemas for supported view types and their properties.

Authorizations:
basicAuth
path Parameters
view_uri
required
string
Request Body schema: application/json

The View you'd like to modify

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Deletes a view

This request deletes the specified view, including all graph data.

Authorizations:
basicAuth
path Parameters
view_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Retrieves the status of a step

This request retrieves status information for the specified step.

Authorizations:
basicAuth
path Parameters
step_uri
required
string
query Parameters
detail
boolean

Whether to show detailed status information

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Retrieves a run configuration

This request retrieves the title, description, URI, and enabled layers/views/steps of a run config. When expand=* is specified in the request, additional details are retrieved.

Authorizations:
basicAuth
path Parameters
runconfig_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Modifies a run configuration

This request updates the configuration properties for the specified run configuration. PATCH requests do not require any specific body parameters. However, if the request does include any of the parameters that are denoted as required in the schema below, their values cannot be null.

Authorizations:
basicAuth
path Parameters
runconfig_uri
required
string
Request Body schema: application/json

The RunConfig you'd like to modify

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Deletes a run configuration

This request deletes the specified run configuration.

Authorizations:
basicAuth
path Parameters
runconfig_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

datasets

Datasets Operations

Returns all datasets the user has permission to view

This request returns the type, title, URI, and data location for all File-based linked datasets the user has permission to view. When expand=* is specified, details such as the created date, creator, and modifier are retrieved as well as information about editions and components.

Authorizations:
basicAuth
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves details about a dataset

This request returns the type, URI, title, and data location for the specified dataset.

Authorizations:
basicAuth
path Parameters
dataset_uri
required
string

The encoded URI of the object

query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Creates or replaces a dataset

This request replaces an existing dataset or creates a new empty dataset with the specified URI at the specified location on a fileConnection. When adding the value for the required filePath body parameter, take into account that the value of fileConnection may already contain a partial path to the location of the dataset directory and filePath is appended to fileConnection. If the directory specified in filePath does not exist, it will be created.

Authorizations:
basicAuth
path Parameters
dataset_uri
required
string
query Parameters
force
required
boolean
Default: false

Controls whether to force the replacement of an existing dataset in the request. If false (the default value), an error is returned if you reference an existing dataset URI. To force the removal of an existing dataset, include force=true.

Request Body schema: application/json

Create Dataset Request Body

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Modifies a dataset

This request updates configuration properties for the specified dataset. PATCH requests do not require any specific body parameters. However, if the request does include any of the parameters that are denoted as required in the schema below, their values cannot be null.

Authorizations:
basicAuth
path Parameters
dataset_uri
required
string

The encoded URI of the object

Request Body schema: application/json

The dataset you'd like to modify

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Deletes a dataset

This request deletes an existing dataset as well as any associated editions and components. This request does not delete the dataset or its editions and components from disk. It removes the dataset entry from Studio's Datasets catalog.

Authorizations:
basicAuth
path Parameters
dataset_uri
required
string

The encoded URI of the object

query Parameters
force
required
boolean
Default: false

Controls if dataset will be deleted where confirmation is required. If false (the default value), the confirmation message is returned. To force the removal of dataset, include force=true.

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Imports a dataset from an FLDS

This request imports a dataset from an existing FLDS on disk. When adding the value for the required filePath body parameter, take into account that the value of fileConnection may already contain a partial path to the location of the directory that contains flds.trig and filePath is appended to fileConnection.

Authorizations:
basicAuth
query Parameters
conflict_resolution
string

This parameter specifies what to do if this import will result in conflicting graphs. There are two options: rename or replace. If “rename,” the existing conflicting graphs are renamed. If “replace,” existing graphs are overwritten. If there are conflicting graphs and conflict-resolution is not specified, an error is returned.

skipOntologies
boolean

When this parameter is true the FLDS's ontologies will not be imported.

Request Body schema: application/json

Create Dataset Request Body

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Imports a dataset from an FLDS in a zip file

This request imports a dataset from an existing FLDS inside a zip file.

Authorizations:
basicAuth
query Parameters
conflict_resolution
string

This parameter specifies what to do if this import will result in conflicting graphs. There are two options: rename or replace. If “rename,” the existing conflicting graphs are renamed. If “replace,” existing graphs are overwritten. If there are conflicting graphs and conflict-resolution is not specified, an error is returned.

skipOntologies
boolean

When this parameter is true the FLDS's ontologies will not be imported.

Request Body schema: multipart/form-data

Import FLDS Zip Request Body

fileConnection
string <uri>

The URI for the shared file store

filePath
string

The path to the file directory on the shared file store

Array of objects (Tag)
tagTitle
Array of strings
fldsZip
required
string <binary>

the FLDS zip file to import

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Creates a dataset from an RDF directory

This request creates a dataset from an RDF directory of TTL, NT, or N3 files on a fileConnection. RDF files must be placed in a directory named rdf.filetype or rdf.filetype.gz. Place uncompressed TTL files in a directory called rdf.ttl, and place compressed TTL files in a directory called rdf.ttl.gz. Place uncompressed N-Triple files in a directory called rdf.nt or rdf.n3, depending on the file type extension. Place compressed N-Triple files in an rdf.nt.gz or rdf.n3.gz directory. When adding the value for the required filePath body parameter, take into account that the value of fileConnection may already contain a partial path to the location of the RDF directory and filePath is appended to fileConnection.

Authorizations:
basicAuth
Request Body schema: application/json

Create Dataset Request Body

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Creates a dataset from an RDF directory that has been zipped

This request creates a dataset from a zipped RDF directory of TTL, NT, or N3 files. The ZIP file must include an rdf.filetype subdirectory that contains the RDF files. Place uncompressed TTL files in a directory called rdf.ttl, and place compressed TTL files in a directory called rdf.ttl.gz. Place uncompressed N-Triple files in a directory called rdf.nt or rdf.n3, depending on the file type extension. Place compressed N-Triple files in an rdf.nt.gz or rdf.n3.gz directory.

Authorizations:
basicAuth
Request Body schema: multipart/form-data

Import RDF Directory Zip Request Body

fileConnection
string <uri>

The URI for the shared file store

filePath
string

The path to the file directory on the shared file store

title
required
string

The name of the dataset

description
string

A brief description of the dataset

models
Array of strings <uri> [ items <uri > ]

The URIs of the ontologies to associate with this dataset. Each URI should be entered in the following format without quotes ',,...'

Array of objects (Tag)
tagTitle
Array of strings
rdfZip
required
string <binary>

the RDF zip file to import

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Creates an empty dataset

This request creates an empty dataset at the specified location on a fileConnection. When adding the value for the required filePath body parameter, take into account that the value of fileConnection may already contain a partial path to the location of the dataset directory and filePath is appended to fileConnection. If the directory specified in filePath does not exist, it will be created.

Authorizations:
basicAuth
Request Body schema: application/json

Create Dataset Request Body

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Returns a list of editions for a dataset

This request retrieves the type, URI, and title for all editions in the specified dataset.

Authorizations:
basicAuth
path Parameters
dataset_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an edition

This request creates an edition in the specified dataset.

Authorizations:
basicAuth
path Parameters
dataset_uri
required
string
Request Body schema: application/json

Create Edition Request Body

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Deletes an edition

This request deletes the specified edition and its associated components from the dataset.

Authorizations:
basicAuth
path Parameters
dataset_uri
required
string
edition_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Returns a list of components for a dataset

This request retrieves the type, URI, and created timestamp for all components in the specified dataset.

Authorizations:
basicAuth
path Parameters
dataset_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes a component from a dataset

This request deletes the specified component from the given dataset.

Authorizations:
basicAuth
path Parameters
dataset_uri
required
string
component_uri
required
string
query Parameters
delete_on_disk
boolean

Indicates whether the RDF data should also be deleted on disk

force
boolean

Indicates whether a component should be deleted if it is being used in an edition

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Creates a dataset component from rdf

This request creates a dataset component from a TTL, NT, or N3 RDF file. The file name extension should match the format specific on the dataset. Place uncompressed TTL in a file with extension .ttl, and place compressed TTL in a file with extension .ttl.gz. Place uncompressed N-Triple in a file with extension .nt or .n3, depending on the file type extension. Place compressed N-Triple in a file with extension .nt.gz or .n3.gz directory.

Authorizations:
basicAuth
path Parameters
dataset_uri
required
string
Request Body schema: multipart/form-data

Import component data request body

title
required
string

The title of the component

Array of objects (Tag)
tagTitle
Array of strings
rdfFile
required
string <binary>

the rdf file to import

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Archives editions of a dataset

This request archives the specified editions of a dataset and optionally deletes old archives according to the dataset's maxArchives property. Archives the working edition if none are specified.

Authorizations:
basicAuth
path Parameters
dataset_uri
required
string
query Parameters
ageOffEditions
boolean
Request Body schema: application/json

The list of edition URIs to archive. If none are specified, defaults to the working edition.

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Retrieves a dataset edition

This request returns the type, title, and URI for the specified edition.

Authorizations:
basicAuth
path Parameters
edition_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Modifies an edition

This request updates configuration properties for the specified edition. PATCH requests do not require any specific body parameters. However, if the request does include any of the parameters that are denoted as required in the schema below, their values cannot be null.

Authorizations:
basicAuth
path Parameters
edition_uri
required
string
Request Body schema: application/json

The Edition you'd like to modify

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Deletes an edition

This request deletes the specified edition.

Authorizations:
basicAuth
path Parameters
edition_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Retrieves a component

This request retrieves the specified dataset component.

Authorizations:
basicAuth
path Parameters
component_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Deletes a component

This request deletes the specified component.

Authorizations:
basicAuth
path Parameters
component_uri
required
string
query Parameters
delete_on_disk
boolean

Indicates whether the RDF data should also be deleted on disk

force
boolean

Indicates whether a component should be deleted if it is being used in an edition

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Modifies a component

This request modifies a dataset component. PATCH requests do not require any specific body parameters. However, if the request does include any of the parameters that are denoted as required in the schema below, their values cannot be null.

Authorizations:
basicAuth
path Parameters
component_uri
required
string
Request Body schema: application/json

The Component you'd like to modify

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

acls

ACLs Operations

Retrieves the ACLs for an object

This request retrieves the inherited and explicit ACLs that are set for a given object.

Authorizations:
basicAuth
path Parameters
object_uri
required
string

The encoded URI of the object

query Parameters
aclInheritedBy
boolean

Whether to include objects that inherit from the requested object

Responses

Response samples

Content type
application/json
{}

Sets the ACLs for an object

This request sets the ACLs for an object by replacing all existing ACLs with the ones in the request.

Authorizations:
basicAuth
Request Body schema: application/json

Set ACLs Request Body

Array of objects (AclDetailsSet)
preserveInheritance
boolean

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Edits the ACLs for an object

This request modifies the ACLs for an object by adding or removing ACL statements. Requests for removals of statements that do not exist will not trigger errors. ACLs are processed in the order given. If there are conflicts, the last statements override previous statements.

Authorizations:
basicAuth
Request Body schema: application/json

Edit ACLs Request Body

Array of objects (AclDetailsEdit)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Resets ACLs to the Default Access Policy

This request updates the ACLs for the given object by resetting the statements according to the associated Default Access Policy. Inheritance statements are not modified by this method.

Authorizations:
basicAuth
path Parameters
object_uri
required
string

The encoded URI of the object

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

du

Unstructured Operations

Runs an unstructured pipeline

This request runs the specified unstructured pipeline.

Authorizations:
basicAuth
path Parameters
pipeline_uri
required
string
Request Body schema: application/json

Run Pipeline Request Body

anzoLaunchConfiguration
string

For K8s deployments, the URI for the Studio Agent launch configuration

duLaunchConfiguration
string

For K8s deployments, the URI for the DU launch configuration

esLaunchConfiguration
string

For K8s deployments, the URI for the Elasticsearch launch configuration

Responses

Request samples

Content type
application/json
{
  • "anzoLaunchConfiguration": "string",
  • "duLaunchConfiguration": "string",
  • "esLaunchConfiguration": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Cancels an unstructured pipeline

This request cancels an unstructured pipeline that is currently running.

Authorizations:
basicAuth
path Parameters
pipeline_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Retrieves the status of an unstructured pipeline

This request returns information about the status of an unstructured pipeline.

Authorizations:
basicAuth
path Parameters
pipeline_uri
required
string
query Parameters
detail
boolean

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

models

Models Operations

Uploads a model

This request uploads an ontology file to Studio.

Authorizations:
basicAuth
Request Body schema: multipart/form-data
modelData
string <binary>

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Returns a list of all models

This request returns a list of all models

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • "string"
]

Deletes a model

This request deletes the specified model.

Authorizations:
basicAuth
path Parameters
model_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Download a model

This request downloads the specified model.

Authorizations:
basicAuth
path Parameters
model_uri
required
string
query Parameters
format
string
Default: "trig"

The RDF Format to use for the retrieved model. Only TRIG and OWL are supported.

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

migration

Migration Package Operations

Import a Migration Package

Imports a given Migration Package

Authorizations:
basicAuth
query Parameters
force
boolean

If any graphs lack sufficient import permissions, force a partial import consisting of graphs with sufficient permissions

Request Body schema: multipart/form-data

Import Migration Package Request Body

newVersionLabel
string

Name for the version created from this import

newVersionComment
string

Description for the version created from this import

currentStateVersionLabel
string

Name for the version created for the current state of the journal

currentStateVersionComment
string

Description for the version created for the current state of the journal

applyImport
boolean

Whether to apply this import as the current state of the journal or just create a version containing the imported data

migrationPackage
required
string <binary>

the Migration Package to import

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

Export a Migration Package

Exports a given Migration Package

Authorizations:
basicAuth
path Parameters
migration_package_uri
required
string
Request Body schema: application/json

Export Migration Package Request Body

object (DataLocation)

Responses

Request samples

Content type
application/json
{
  • "exportDataLocation": {
    }
}

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Creates a migration package

Creates a migration package

Authorizations:
basicAuth
Request Body schema: application/json

Create Migration Package Request Body

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Retrieves all migration packages

This request returns the title, type, URI, and core artifacts for all migration packages the user has permission to view. When expand=* is specified in the request, additional information is also retrieved.

Authorizations:
basicAuth
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns information about a migration package

This request retrieves the title, type, URI, and core artifacts for a migration package. When expand=* is specified in the request, additional details are also retrieved.

Authorizations:
basicAuth
path Parameters
migration_package_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

azgs

Lakehouse operations

Returns a list of static Lakehouse Connections

This request returns all of the static Lakehouse Connections the user has permission to view.

Authorizations:
basicAuth
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new static Lakehouse

This request is used to create and configure a new static Lakehouse Connection. The title and host properties are required.

Authorizations:
basicAuth
Request Body schema: application/json

Configuration details for the new static Lakehouse Connection.

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Returns information about a static Lakehouse Connection

This request retrieves the title, description, host and URI for a static Lakehouse Connection. When expand=* is specified in the request, further details are returned.

Authorizations:
basicAuth
path Parameters
anzograph_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Creates or replaces a static Lakehouse Connection

This request replaces an existing static Lakehouse Connection or creates a new one with the specified URI.

Authorizations:
basicAuth
path Parameters
anzograph_uri
required
string
query Parameters
force
required
boolean
Default: false

Controls if Lakehouse Connection will be deleted where confirmation is required. If false (the default value), the confirmation message is returned. To force the removal of static Lakehouse Connection, include force=true.

Request Body schema: application/json

The static Lakehouse Connection you'd like to replace or create

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Modifies a static Lakehouse Connection

This request updates properties for the specified static Lakehouse Connection. PATCH requests do not require any specific body parameters. However, if the request does include any of the parameters that are denoted as required in the schema below, their values cannot be null.

Authorizations:
basicAuth
path Parameters
anzograph_uri
required
string
Request Body schema: application/json

The static Lakehouse Connection you'd like to modify

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Deletes a static Lakehouse Connection

This request deletes the specified static Lakehouse Connection.

Authorizations:
basicAuth
path Parameters
anzograph_uri
required
string
query Parameters
force
required
boolean
Default: false

Controls if static Lakehouse Connection will be deleted where confirmation is required. If false (the default value), the confirmation message is returned. To force the removal of static Lakehouse Connection, include force=true.

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

Reconnects to a static Lakehouse Server

This request asynchronously reconnects to the specified static static Lakehouse Server.

Authorizations:
basicAuth
path Parameters
anzograph_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

launchconfigs

Launch Config operations

Returns a list of dynamic Lakehouse Launch Configs

This request returns all of the dynamic Lakehouse Launch Configs the user has permission to view.

Authorizations:
basicAuth
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of dynamic Elasticsearch Launch Configs

This request returns all the dynamic Elasticsearch Launch Configs the user has permission to view.

Authorizations:
basicAuth
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

versioning

Create Version of an object

This request creates a version of an object.

Authorizations:
basicAuth
Request Body schema: application/json

Configuration details for version creation.

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}

sso

Retrieves all SSO providers

This request returns all SSO providers the user has permission to view. Each SSO provider returns the title, description, and container id properties by default, unless an alternative expand string is provided.

Authorizations:
basicAuth
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new SSO provider

This request is used to create and configure a new SSO provider.

Authorizations:
basicAuth
Request Body schema: application/json

Configuration details for the new SSO provider.

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Returns information about a SSO provider

This request retrieves parameters for a SSO provider.

Authorizations:
basicAuth
path Parameters
sso_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Creates or replaces a SSO provider

This request replaces an existing SSO provider or creates a new one with the specified URI.

Authorizations:
basicAuth
path Parameters
sso_uri
required
string
Request Body schema: application/json

The SSO provider you'd like to replace or create

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Modifies a SSO provider

This request updates configuration properties for the specified SSO provider. PATCH requests do not require any specific body parameters. However, if the request does include any of the parameters that are denoted as required in the schema below, their values cannot be null.

Authorizations:
basicAuth
path Parameters
sso_uri
required
string
Request Body schema: application/json

The SSO provider you'd like to modify

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Deletes a SSO provider

This request deletes the specified SSO provider, including all of the data layers, steps, and graph data.

Authorizations:
basicAuth
path Parameters
sso_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

es

Retrieves all Elasticsearch configs

This request returns all Elasticsearch configs the user has permission to view. Each Elasticsearch config returns the title, host, and port properties by default, unless an alternative expand string is provided.

Authorizations:
basicAuth
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

filter
string

A filter to apply to limit the data that is returned. You can filter on any of the object's parameters by including filter=<parameter>:<value> in the request. All values must be URL-encoded. If the value is a URI or a string with spaces, include encoded quotation marks around the value. For example to filter on title:"This is a Title", the filter statement would be filter=title%3A%22This%20is%20a%20Title%22. Wildcards are also supported for contains-type filters. For example, filter=title%3A%22%2AThe%2A%22 is filter=title:"*The*".

limit
integer

The number of records to include in the response

offset
integer

The offset to use when retrieving records

sort
string

Defines the sort order for the requested records. You can sort on any of the object's parameters by including sort=<parameter> in the request. For descending order, include sort=-<parameter>. For example, sort=-title.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new Elasticsearch config

This request is used to create and configure a new Elasticsearch config.

Authorizations:
basicAuth
Request Body schema: application/json

Configuration details for the new Elasticsearch config.

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Returns information about a Elasticsearch config

This request retrieves parameters for a Elasticsearch config.

Authorizations:
basicAuth
path Parameters
es_uri
required
string
query Parameters
expand
string

An expansion definition instructing the server what data to include in the response

Responses

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Creates or replaces a Elasticsearch config

This request replaces an existing Elasticsearch config or creates a new one with the specified URI.

Authorizations:
basicAuth
path Parameters
es_uri
required
string
Request Body schema: application/json

The Elasticsearch config you'd like to replace or create

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Modifies a Elasticsearch config

This request updates configuration properties for the specified Elasticsearch config. PATCH requests do not require any specific body parameters. However, if the request does include any of the parameters that are denoted as required in the schema below, their values cannot be null.

Authorizations:
basicAuth
path Parameters
es_uri
required
string
Request Body schema: application/json

The Elasticsearch config you'd like to modify

title
string
customProps
object
Array of objects (Tag)
tagTitle
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "title": "string",
  • "customProps": { },
  • "tags": [
    ],
  • "tagTitle": [
    ],
  • "type": "Thing"
}

Response samples

Content type
application/json
Example
{
  • "uri": "http://example.com",
  • "type": "Thing",
  • "title": "string",
  • "allTypes": [
    ],
  • "customProps": { },
  • "@context": [
    ],
  • "tags": [
    ],
  • "tagTitle": [
    ]
}

Deletes a Elasticsearch config

This request deletes the specified Elasticsearch config, including all of the data layers, steps, and graph data.

Authorizations:
basicAuth
path Parameters
es_uri
required
string

Responses

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "summary": "string",
  • "detail": "string",
  • "isPartial": true
}

utils

Retrieves the version of the server

This request returns the version of the server.

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "detail": "string"
}