API docs by Redocly

Setup Specs Service - API definition (1.0.0)

Download OpenAPI specification:Download

Bosch Connected Industry: Industry4.0.bci@de.bosch.com URL: https://www.bosch-connected-industry.com License: © Robert Bosch Manufacturing Solutions GmbH 2023, all rights reserved Terms of Service

This is the public API description of Setup Specs. It includes endpoints to maintain product hierarchy and setup parameters for process experts.

ProductArea

Get the production areas with the defined filters.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
filter
string

Optional expression for filtering production areas to be returned. It can optionally contain a wildcard * character. E.g. eq(productAreaWildcard, "Area-1*")

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Adds a new production area.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

new node to add

name
required
string [ 1 .. 4000 ] characters
description
string or null <= 4000 characters
userId
string or null
revisionComment
string or null <= 1024 characters
exportType
integer <int32> (ExportType)
Enum: 0 1 2

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "userId": "string",
  • "revisionComment": "string",
  • "exportType": 0
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Updates product area details.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
name
string or null
exportType
integer <int32> (ExportType)
Enum: 0 1 2

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "exportType": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Deletes a list of production areas.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

nodes to delete

nodeIds
required
Array of strings <uuid> [ items <uuid > ]
userId
string or null
revisionComment
string or null [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "nodeIds": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Get the properties of a single area

path Parameters
areaName
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "productionArea": {
    }
}

ProductFamily

Get families for a production area.

path Parameters
area
required
string

Name of production area

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
filter
string

Optional expression for filtering product families to be returned. It can optionally contain a wildcard * character. E.g. eq(productFamilyWildcard, "Family 1*")

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Adds a new product family.

path Parameters
area
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

new node to add

name
required
string [ 1 .. 4000 ] characters
description
string or null <= 4000 characters
userId
string or null
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Deletes a list of product families.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

area
required
string
header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

nodes to delete

nodeIds
required
Array of strings <uuid> [ items <uuid > ]
userId
string or null
revisionComment
string or null [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "nodeIds": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Get history entries for specified product family.

path Parameters
area
required
string

name of production area

family
required
string

name of product family

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "revisionHistory": [
    ]
}

ProductType

Get types for a product family.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
filter
string

Optional expression for filtering product types to be returned. It can optionally contain a wildcard '*' character. E.g. 'eq(productTypeWildcard, "Type 1")'

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Adds a new product type.

path Parameters
area
required
string
family
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

new node to add

name
required
string [ 1 .. 4000 ] characters
description
string or null <= 4000 characters
userId
string or null
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Deletes a list of product types.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

area
required
string
family
required
string
header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

nodes to delete

nodeIds
required
Array of strings <uuid> [ items <uuid > ]
userId
string or null
revisionComment
string or null [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "nodeIds": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

ProductTypeVariant

Get variants for a product type.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
filter
string

Optional expression for filtering product type variants to be returned. It can optionally contain a wildcard * character. E.g. eq(productTypeVariantWildcard, "*Variant 1*")

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Adds a new product type variant.

path Parameters
area
required
string
family
required
string
type
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

new node to add

name
required
string [ 1 .. 4000 ] characters
description
string or null <= 4000 characters
userId
string or null
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Deletes a list of product type variants.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

area
required
string
family
required
string
type
required
string
header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

nodes to delete

nodeIds
required
Array of strings <uuid> [ items <uuid > ]
userId
string or null
revisionComment
string or null [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "nodeIds": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Gets a list of all releases for a product type/family/area.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Gets the product release details about specified product type variant.

path Parameters
area
required
string

name of production area

family
required
string

name of product family

type
required
string

name of the type

variant
required
string

name of the type variant

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "productReleaseDetails": {
    }
}

Gets line release info about specified product type variant.

path Parameters
area
required
string

name of production area

family
required
string

name of product family

type
required
string

name of the type

variant
required
string

name of the type variant

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "tags": {
    },
  • "lineReleaseStatus": {
    },
  • "lineStatusValues": {
    }
}

Updates details for a product type variant.

path Parameters
area
required
string
family
required
string
type
required
string
variant
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
required
object (ProductTypeVariantDetails)
userId
string or null
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "variantDetails": {
    },
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Adds details for a product type variant (line release).

path Parameters
area
required
string
family
required
string
type
required
string
variant
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
required
object (ProductTypeVariantDetails)
userId
string or null
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "variantDetails": {
    },
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Get version and description information about a product type variant.

path Parameters
area
required
string

name of production area

family
required
string

name of product family

type
required
string

name of the type

variant
required
string

name of the type variant

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "revisionNumber": 0,
  • "description": "string"
}

Gets History of specified product type variant.

path Parameters
area
required
string

name of production area

family
required
string

name of product family

type
required
string

name of the type

variant
required
string

name of the type variant

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "revisionHistory": [
    ],
  • "checkpointHistory": [
    ]
}

Updates release information for a product type variant.

path Parameters
area
required
string
family
required
string
type
required
string
variant
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
masterReleaseStatusValue
required
integer <int32>
isActiveRelease
required
boolean
ignoreExistingTickets
boolean
userId
string or null
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "masterReleaseStatusValue": 0,
  • "isActiveRelease": true,
  • "ignoreExistingTickets": true,
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Releases the variant after all data sets are deployed, if configured.

path Parameters
area
required
string
family
required
string
type
required
string
variant
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
any

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Variant batch state change

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
required
Array of objects (TypeVariantReleaseObject) non-empty
userId
string or null
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "variants": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Variant batch state change using queue

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
required
Array of objects (TypeVariantReleaseObject) non-empty
userId
string or null
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "variants": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Delete details for a product type variant.

path Parameters
area
required
string
family
required
string
type
required
string
variant
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
lineReleaseStatusIds
required
Array of strings non-empty
userId
string or null
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "lineReleaseStatusIds": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Deletes a list of product type variants.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

nodes to delete

Array (non-empty)
required
object (TypeVariantReleaseObject)
required
object (TypeVariantReleaseObject)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "errors": [
    ]
}

Queries

Provides search result with given query.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
object (ParameterSearch)
includeDataSetContent
boolean
required
object (PathSearch)

Responses

Request samples

Content type
application/json
{
  • "parameter": {
    },
  • "includeDataSetContent": true,
  • "path": {
    }
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Provides search result for type groups with given query.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
object (ParameterSearch)
typeGroup
required
string non-empty
typeGroupItems
Array of strings or null
includeDataSetContent
boolean

Responses

Request samples

Content type
application/json
{
  • "parameter": {
    },
  • "typeGroup": "string",
  • "typeGroupItems": [
    ],
  • "includeDataSetContent": true
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Creates additional data for a query ticket.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
id
string <uuid>
ticketId
string <uuid>
required
object (QueryTicketInformation)
created
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ticketId": "e3e3e8ea-b02a-4536-85a2-a9c90f4ee74f",
  • "data": {
    },
  • "created": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "item": {
    }
}

Gets additional ticket data with given id.

path Parameters
id
required
string <uuid>
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "item": {
    }
}

Updates additional data for a query ticket.

path Parameters
id
required
string <uuid>
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Provides search result with given id.

path Parameters
id
required
string <uuid>
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ],
  • "query": {
    }
}

Provides search query conditions of given id.

path Parameters
id
required
string <uuid>
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ],
  • "query": {
    }
}

Provides search result with given query.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
required
Array of objects (TypeDataPathDefinition) non-empty
required
object (ParameterSearch)

Responses

Request samples

Content type
application/json
{
  • "dataSets": [
    ],
  • "parameter": {
    }
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Replaces values of given parameters.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
required
Array of objects (ParametersValueReplaceItem) non-empty
revisionComment
required
string [ 1 .. 1024 ] characters
userId
string or null

Responses

Request samples

Content type
application/json
{
  • "parameters": [
    ],
  • "revisionComment": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ],
  • "replacedParameterCount": 0
}

Get all sub-paths that are found for the search parameter in searchPath.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
areas
Array of strings or null <= 4000 items
families
Array of strings or null <= 4000 items
products
Array of strings or null <= 4000 items
variants
Array of strings or null <= 4000 items

Responses

Request samples

Content type
application/json
{
  • "areas": [
    ],
  • "families": [
    ],
  • "products": [
    ],
  • "variants": [
    ]
}

Response samples

Content type
application/json
{
  • "areas": [
    ],
  • "families": [
    ],
  • "products": [
    ],
  • "variants": [
    ],
  • "datasetTypes": [
    ],
  • "datasetNames": [
    ]
}

Scopes

Gets all scope DB connection details.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Creates one scope DB connection detail.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
id
string <uuid>
name
required
string non-empty
description
string or null
type
required
integer <int32> (DBType)
Enum: 0 1 2 3
username
required
string non-empty
password
required
string non-empty
connectionString
required
string non-empty
parameters
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": 0,
  • "username": "string",
  • "password": "string",
  • "connectionString": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": 0,
  • "username": "string",
  • "password": "string",
  • "connectionString": "string",
  • "parameters": "string"
}

Deletes a collection of scope DB connection detail.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
nodeIds
required
Array of strings <uuid> [ items <uuid > ]
userId
string or null
revisionComment
string or null [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "nodeIds": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Gets one scope DB connection detail.

path Parameters
id
required
string <uuid>
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "scope": {
    }
}

Updates one scope DB connection detail.

path Parameters
id
required
string <uuid>
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
id
string <uuid>
name
required
string non-empty
description
string or null
type
required
integer <int32> (DBType)
Enum: 0 1 2 3
username
required
string non-empty
password
required
string non-empty
connectionString
required
string non-empty
parameters
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": 0,
  • "username": "string",
  • "password": "string",
  • "connectionString": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Deletes one scope DB connection detail.

path Parameters
id
required
string <uuid>
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Gets one scope DB connection detail.

path Parameters
id
required
string <uuid>
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "password": "string"
}

Creates one scope DB connection detail.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
id
string <uuid>
name
required
string non-empty
description
string or null
type
required
integer <int32> (DBType)
Enum: 0 1 2 3
username
required
string non-empty
password
required
string non-empty
connectionString
required
string non-empty
parameters
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": 0,
  • "username": "string",
  • "password": "string",
  • "connectionString": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "isSuccess": true,
  • "details": "string"
}

Check connection status for existing scope with given id

path Parameters
id
required
string <uuid>
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "isSuccess": true,
  • "details": "string"
}

TypeData

Get type data of specified partition.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

name of the product type variant

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

id
required
string

identifier of a partition

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
filter
string

Optional expression for filtering type data to be returned. E.g. eq(pathToTypeDataStructure, "Constants/Controller") pathToTypeDataStructure Path to a structure inside of type data. If this path is specified, only a part of the type data that is stored under the given path will be returned. If no filter is passed, all partitions are returned.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "typeData": {
    }
}

Get type data of latest released revision.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

name of the product type variant

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

id
required
string

identifier of a partition

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
filter
string

Optional expression for filtering type data to be returned. E.g. eq(pathToTypeDataStructure, "Constants/Controller") pathToTypeDataStructure Path to a structure inside of type data. If this path is specified, only a part of the type data that is stored under the given path will be returned. If no filter is passed, all partitions are returned.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "typeData": {
    }
}

Get type data of latest released revision.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

name of the product type variant

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

id
required
string

identifier of a partition

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
filter
string

Optional expression for filtering type data to be returned. E.g. eq(pathToTypeDataStructure, "Constants/Controller") pathToTypeDataStructure Path to a structure inside of type data. If this path is specified, only a part of the type data that is stored under the given path will be returned. If no filter is passed, all partitions are returned.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "typeData": {
    }
}

Get list of all type data that has one or multiple parameter linked to a type data in the seach parameter.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

name of the product type variant

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

id
required
string

Id of the partition

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
filter
string

Optional expression for filtering type data to be returned. E.g. eq(pathToTypeDataStructure, "Constants/Controller") pathToTypeDataStructure Path to a structure inside of type data. If this path is specified, only a part of the type data that is stored under the given path will be returned. If no filter is passed, all partitions are returned.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "typeDataPathList": [
    ]
}

Get the revision history of a type data with its checkpoints.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

name of the product type variant

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

id
required
string

identifier of a partition

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
filter
string

Optional expression for filtering type data to be returned. E.g. eq(pathToTypeDataStructure, "Constants/Controller") pathToTypeDataStructure Path to a structure inside of type data. If this path is specified, only a part of the type data that is stored under the given path will be returned. If no filter is passed, all partitions are returned.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "revisionHistory": [
    ],
  • "checkpointHistory": [
    ]
}

Get type data history(new logic: from type data table)

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

name of the product type variant

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

id
required
string

name of the product partition id

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Get type data version information.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

name of the product type variant

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

id
required
string

name of the product partition id

revision
required
integer <int32>

Revision of the type data

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "item": {
    }
}

Gets a list of released type data path infos for the given request.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

id
required
string

identifier of a partition

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Gets a list of sources for a merged type data.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

product type

variant
required
string

Name of product variant

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

id
required
string

identifier of a partition

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Adds a new type data to a variant. Deprecated

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

Name of product variant

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

New type data to add

typeDataDetails
required
string non-empty
userId
string or null
revisionComment
required
string [ 1 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "typeDataDetails": "string",
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Updates a type data object.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

Name of product variant

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

Type data to add

typeDataDetails
required
string non-empty
userId
string or null
revisionComment
required
string [ 1 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "typeDataDetails": "string",
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Get the release information of a type data.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

name of the product type variant

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

partitionId
required
string

name of the product partition id

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "releaseObject": {
    }
}

Updates release information for a data set.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

name of the product type variant

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

partitionId
required
string

name of the product partition id

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
datasetReleaseStatusValue
required
integer <int32> (DatasetReleaseState)
Enum: 0 2 3 -2
userId
string or null
revisionComment
required
string [ 1 .. 1024 ] characters
hasUnreleasedChanges
boolean

Responses

Request samples

Content type
application/json
{
  • "datasetReleaseStatusValue": 0,
  • "userId": "string",
  • "revisionComment": "string",
  • "hasUnreleasedChanges": true
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Updates release (emergency released) information for a data set.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

name of the product type variant

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

partitionId
required
string

name of the product partition id

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
datasetReleaseStatusValue
required
integer <int32> (DatasetReleaseState)
Enum: 0 2 3 -2
userId
string or null
revisionComment
required
string [ 1 .. 1024 ] characters
hasUnreleasedChanges
boolean

Responses

Request samples

Content type
application/json
{
  • "datasetReleaseStatusValue": 0,
  • "userId": "string",
  • "revisionComment": "string",
  • "hasUnreleasedChanges": true
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Updates release information for a collection of data set.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

Data set to change release state.

required
Array of objects (DatasetBatchReleaseObjectItem) non-empty
userId
string or null
revisionComment
required
string [ 1 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "datasets": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ],
  • "succeededCount": 0,
  • "failReason": "string"
}

Queues updates release information for a collection of data sets.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

Data set to change release state.

required
Array of objects (DatasetBatchReleaseObjectItem) non-empty
userId
string or null
revisionComment
required
string [ 1 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "datasets": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Deletes given data sets.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
nodeIds
required
Array of strings <uuid> [ items <uuid > ]
userId
string or null
revisionComment
string or null [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "nodeIds": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Gets all data sets of given area.

path Parameters
area
required
string

Area name.

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Gets the dat file of type data with given path.

path Parameters
area
required
string
family
required
string
type
required
string
variant
required
string
partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1
partitionId
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
No sample

TypeDataConflict

Get all conflicts for a variant.

path Parameters
area
required
string
family
required
string
type
required
string
variant
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

TypeDataImporter

Get type data groups or get type data group by specified group id

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
groupId
string <uuid>
header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Update a type data group

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
excludeItems
boolean
Default: true

if true, do not to update group related items

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

a type data group

id
required
string <uuid>
status
integer <int32> (ImportStatus)
Enum: 0 1 2 3 4 5 6
Array of objects or null (TypeDataItem)
required
object (ImportActionDetail)
userId
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": 0,
  • "sourceData": [
    ],
  • "details": {
    },
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "details": "string"
}

Delete a type data group

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
groupId
required
string <uuid>
header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "details": "string"
}

Get the content of a type data item

path Parameters
groupId
required
string <uuid>
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
itemId
string <uuid>
header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
"string"

Replace the file content of a type data item

path Parameters
groupId
required
string <uuid>
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
itemId
required
string <uuid>
header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
productArea
string or null <= 255 characters
productFamily
string or null <= 255 characters
productType
string or null <= 255 characters
typeVariant
string or null <= 255 characters
partitionType
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1
partitionId
string or null <= 255 characters
id
required
string <uuid>
filePath
required
string non-empty
fileContent
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "productArea": "string",
  • "productFamily": "string",
  • "productType": "string",
  • "typeVariant": "string",
  • "partitionType": 0,
  • "partitionId": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "filePath": "string",
  • "fileContent": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "details": "string"
}

Update type data item in a group

path Parameters
groupId
required
string <uuid>
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
id
required
string <uuid>
groupId
required
string <uuid>
path
required
string [ 1 .. 2000 ] characters
status
integer <int32> (ImportStatus)
Enum: 0 1 2 3 4 5 6
required
object (TypeDataMeta)
fileContent
string or null <byte>
object (ImportErrorContent)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "path": "string",
  • "status": 0,
  • "typeData": {
    },
  • "fileContent": "string",
  • "errorContent": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "details": "string"
}

Delete type data items in a group

path Parameters
groupId
required
string <uuid>
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "details": "string"
}

Get type data files from uploaded zip file.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema:
file
required
string <binary>

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

TypeDataPartition

Get type data partitions for specified product type variant.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

name of the product type variant

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
releasedOnly
boolean
Default: false

Optional parameter to return only released partitions).

filter
string

Optional expression for filtering partitions to be returned. E.g. eq(typeDataPartitionId, "1") It can contain Partition-Uuid of the searched partition (0 = LocationSpecific, 1 = ProcessSpecific, 2 = ApplicationSpecific, 3 = Shared). If no filter is passed, all partitions are returned.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Add type data（initial）

path Parameters
area
required
string
family
required
string
type
required
string
variant
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
Array of objects or null (PartitionItem)
typeGroups
Array of strings or null
revisionComment
string or null <= 1024 characters
userId
string or null

Responses

Request samples

Content type
application/json
{
  • "partitions": [
    ],
  • "typeGroups": [
    ],
  • "revisionComment": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Deletes a list of type data structures.

path Parameters
area
required
string
family
required
string
type
required
string
variant
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
nodeIds
Array of strings or null <uuid>
Array of objects or null (DatasetDeleteInfo)
typeGroupNames
Array of strings or null
userId
string or null
revisionComment
string or null [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "nodeIds": [
    ],
  • "datasetsInfos": [
    ],
  • "typeGroupNames": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Get type data partitions that are not already assigned to a specified product type variant.

path Parameters
area
required
string

Name of production area

family
required
string

Name of product family

type
required
string

Name of product type

variant
required
string

name of the product type variant

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Get the type groups with count of child items .

path Parameters
area
required
string
family
required
string
type
required
string
variant
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Gets info about selected datasets to remove and array of other datasets that are effected by this removal

path Parameters
area
required
string
family
required
string
type
required
string
variant
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

TypeDataStructure

Get type data structures by area only.

path Parameters
area
required
string

Name of production area

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Get type data structure of specified partition.

path Parameters
area
required
string

Name of production area

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

partitionId
required
string

name of the partition

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
filter
string

Optional expression for filtering type data to be returned. E.g. eq(revision, "252") and eq(pathToTypeDataStructure, "Constants/Controller") revision REVISION number. If specified, type data of an exact revision will be returned. If omitted, the latest revision of type data will be returned. pathToTypeDataStructure Path to a structure inside of type data. If this path is specified, only a part of the type data that is stored under the given path will be returned. If no filter is passed, all partitions are returned.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "typeDataStructure": {
    }
}

Gets type data structure of specified revision, less than lessThan. If both revision and lessThan are not provided, latest structure will be the result.

path Parameters
area
required
string

Name of production area

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

partitionId
required
string

name of the partition

revision
required
integer <int32>

Revision number

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
lessThan
integer <int32>

Revision number less than

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "typeDataStructure": {
    }
}

Adds a new type data structure of specified partition with setting export option for creating new type data structure.

path Parameters
area
required
string

Name of production area

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

partitionId
required
string

name of the partition

exportType
required
integer <int32> (ExportType)
Enum: 0 1 2

Export type

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

the new to add structure object

typeDataStructure
required
string non-empty
userId
string or null
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "typeDataStructure": "string",
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Adds a new type data structure of specified partition.

path Parameters
area
required
string

Name of production area

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

partitionId
required
string

name of the partition

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

the new to add structure object

typeDataStructure
required
string non-empty
userId
string or null
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "typeDataStructure": "string",
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Updates an existing type data structure.

path Parameters
area
required
string

Name of production area

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

Type of the partition. 0 = LocationSpecific, 1 = ProcessSpecific 2 = ApplicationSpecific

partitionId
required
string

name of the partition

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

the updated structure object

typeDataStructure
required
string non-empty
userId
string or null
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "typeDataStructure": "string",
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Deletes a list of type data structures.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

area
required
string
header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

nodes to delete

nodeIds
required
Array of strings <uuid> [ items <uuid > ]
userId
string or null
revisionComment
string or null [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "nodeIds": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Get Export type for structure path.

path Parameters
area
required
string
partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1
partitionId
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
0
0

Updates the export type for given path.

path Parameters
area
required
string
partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1
partitionId
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
exportType
integer <int32> (ExportType)
Enum: 0 1 2

Responses

Request samples

Content type
application/json
{
  • "exportType": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

TypeGroup

Get the type groups with the defined filters.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
filter
string

Optional expression for filtering type group to be returned. It can optionally contain a wildcard * character. E.g. eq(productAreaWildcard, "Area-1*")

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Adds a new type group.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

new node to add

name
required
string [ 1 .. 4000 ] characters
description
string or null <= 4000 characters
userId
string or null
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Deletes a list of type groups.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

nodes to delete

nodeIds
required
Array of strings <uuid> [ items <uuid > ]
userId
string or null
revisionComment
string or null [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "nodeIds": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Edits a type group

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
originName
string or null
targetName
string or null
revisionComment
string or null
userId
string or null

Responses

Request samples

Content type
application/json
{
  • "originName": "string",
  • "targetName": "string",
  • "revisionComment": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Copies a type group with all its items

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
typeGroupSourceName
string or null
typeGroupTargetName
string or null
description
string or null
revisionComment
string or null
userId
string or null

Responses

Request samples

Content type
application/json
{
  • "typeGroupSourceName": "string",
  • "typeGroupTargetName": "string",
  • "description": "string",
  • "revisionComment": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

TypeGroupItem

Get the type group items with the defined filters.

path Parameters
typeGroup
required
string

returns the items stored under this type group

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

query Parameters
filter
string

Optional expression for filtering type group to be returned. It can optionally contain a wildcard * character. E.g. eq(productAreaWildcard, "Area-1*")

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "items": [
    ]
}

Get a specific type group item with the defined filters.

path Parameters
typeGroup
required
string

type group filter

partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1

partition type filter Bosch.Nexeed.SetupControl.Shared.Enum.TypeDataPartitionEnum

partitionId
required
string

partition id filter

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Responses

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "typeGroupItem": {
    }
}

Adds a new type group item.

path Parameters
typeGroup
required
string

new type group item to add

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

new type group item to add

typeGroupItemName
string or null
specification
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1
exportType
integer <int32> (ExportType)
Enum: 0 1 2
typeDataStructure
required
string non-empty
nodeId
string <uuid>
userId
string or null
revision
integer <int32>
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "typeGroupItemName": "string",
  • "specification": 0,
  • "exportType": 0,
  • "typeDataStructure": "string",
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177",
  • "userId": "string",
  • "revision": 0,
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177"
}

Updates a existing type group item instance.

path Parameters
typeGroup
required
string

type group name where type group is stored

tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

updated type group item data

typeGroupItemName
string or null
specification
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1
exportType
integer <int32> (ExportType)
Enum: 0 1 2
typeDataStructure
required
string non-empty
nodeId
string <uuid>
userId
string or null
revision
integer <int32>
revisionComment
string or null <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "typeGroupItemName": "string",
  • "specification": 0,
  • "exportType": 0,
  • "typeDataStructure": "string",
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177",
  • "userId": "string",
  • "revision": 0,
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "queryProperties": {
    },
  • "nodeId": "959356e3-6168-4a92-b4a5-b9d462be6177",
  • "countChanges": 0
}

Deletes a list of type groups.

path Parameters
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required

nodes to delete

nodeIds
required
Array of strings <uuid> [ items <uuid > ]
userId
string or null
revisionComment
string or null [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "nodeIds": [
    ],
  • "userId": "string",
  • "revisionComment": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}

Updates the export type for given path.

path Parameters
typeGroup
required
string
partitionType
required
integer <int32> (TypeDataPartitionEnum)
Enum: 0 1 2 3 -1
partitionId
required
string
tenant-id
required
string
Example: 7311ea8c-5d48-43fe-acf9-980eedf24b6c

Identifier of the organization, for which the resource is belonging to.

header Parameters
Scope-Id
string

Data source scope, allow user connect to particular database which is configured in Specs UI Scopes tab. Empty scope will connect the default database

Request Body schema: application/json
required
exportType
integer <int32> (ExportType)
Enum: 0 1 2

Responses

Request samples

Content type
application/json
{
  • "exportType": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "path": "string",
  • "details": {
    }
}