v1.0

open-dpp

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

API specification for open-dpp

Contact

Servers

http://localhost:3000Local

https://api.cloud.open-dpp.deProduction

---

Template

Operations

GET/organizations/{organizationId}/templates/{templateId}GET/organizations/{organizationId}/templates

---

Find template by id

GET

/organizations/{organizationId}/templates/{templateId}

Find template by id.

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

organizationId*

Typestring

Required

templateId*

The id of the template.

Typestring

Required

formatuuid

Responses

Content-Type

application/json

{

"id": "string",

"name": "string",

"description": "string",

"sectors": [

"string"

],

"version": "string",

"sections": [

{

"id": "string",

"name": "string",

"type": "string",

"parentId": "string",

"subSections": [

"string"

],

"dataFields": [

{

"id": "string",

"name": "string",

"type": "string",

"options": {

"additionalProperties": "string"

},

"granularityLevel": "string",

"layout": {

"colStart": {

"xs": 0,

"sm": 0,

"md": 0,

"lg": 0,

"xl": 0

},

"colSpan": {

"xs": 0,

"sm": 0,

"md": 0,

"lg": 0,

"xl": 0

},

"rowStart": {

"xs": 0,

"sm": 0,

"md": 0,

"lg": 0,

"xl": 0

},

"rowSpan": {

"xs": 0,

"sm": 0,

"md": 0,

"lg": 0,

"xl": 0

}

}

}

],

"granularityLevel": "string",

"layout": {

"colStart": {

"xs": 0,

"sm": 0,

"md": 0,

"lg": 0,

"xl": 0

},

"colSpan": {

"xs": 0,

"sm": 0,

"md": 0,

"lg": 0,

"xl": 0

},

"rowStart": {

"xs": 0,

"sm": 0,

"md": 0,

"lg": 0,

"xl": 0

},

"rowSpan": {

"xs": 0,

"sm": 0,

"md": 0,

"lg": 0,

"xl": 0

}

}

}

],

"createdByUserId": "string",

"ownedByOrganizationId": "string",

"marketplaceResourceId": "string"

}

GET

/organizations/{organizationId}/templates/{templateId}

Playground

Server

Authorization

api_token

Variables

Key

Value

organizationId*

templateId*

Samples

cURL

JavaScript

PHP

Python

---

Find all templates

GET

/organizations/{organizationId}/templates

Find all templates which belong to the user's organization.

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

organizationId*

Typestring

Required

Responses

Content-Type

application/json

{

"id": "string",

"name": "string",

"version": "string",

"description": "string",

"sectors": [

"string"

]

}

GET

/organizations/{organizationId}/templates

Playground

Server

Authorization

api_token

Variables

Key

Value

organizationId*

Samples

cURL

JavaScript

PHP

Python

---

Items

Operations

GET/organizations/{orgaId}/models/{modelId}/itemsPOST/organizations/{orgaId}/models/{modelId}/itemsGET/organizations/{orgaId}/models/{modelId}/items/{itemId}POST/organizations/{orgaId}/models/{modelId}/items/{itemId}/data-valuesPATCH/organizations/{orgaId}/models/{modelId}/items/{itemId}/data-values

---

Find items of model

GET

/organizations/{orgaId}/models/{modelId}/items

Find all item which belong to the specified model.

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

orgaId*

The id of the organization you are a member of.

Typestring

Required

formatuuid

modelId*

The id of the model. A item always belongs to a model.

Typestring

Required

formatuuid

Responses

Content-Type

application/json

[

{

"id": "string",

"uniqueProductIdentifiers": [

{

"uuid": "string",

"value": "string"

}

],

"templateId": "string",

"dataValues": [

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

]

}

]

GET

/organizations/{orgaId}/models/{modelId}/items

Playground

Server

Authorization

api_token

Variables

Key

Value

orgaId*

modelId*

Samples

cURL

JavaScript

PHP

Python

---

Create a new item

POST

/organizations/{orgaId}/models/{modelId}/items

Creates a new item for the specified model. It uses the template of the model.

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

orgaId*

The id of the organization you are a member of.

Typestring

Required

formatuuid

modelId*

The id of the model. A item always belongs to a model.

Typestring

Required

formatuuid

Responses

Content-Type

application/json

{

"id": "string",

"uniqueProductIdentifiers": [

{

"uuid": "string",

"value": "string"

}

],

"templateId": "string",

"dataValues": [

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

]

}

POST

/organizations/{orgaId}/models/{modelId}/items

Playground

Server

Authorization

api_token

Variables

Key

Value

orgaId*

modelId*

Samples

cURL

JavaScript

PHP

Python

---

Find item by id

GET

/organizations/{orgaId}/models/{modelId}/items/{itemId}

Find and return the item with the requested id.

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

orgaId*

The id of the organization you are a member of.

Typestring

Required

formatuuid

modelId*

The id of the model. A item always belongs to a model.

Typestring

Required

formatuuid

itemId*

The id of the item.

Typestring

Required

formatuuid

Responses

Content-Type

application/json

{

"id": "string",

"uniqueProductIdentifiers": [

{

"uuid": "string",

"value": "string"

}

],

"templateId": "string",

"dataValues": [

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

]

}

GET

/organizations/{orgaId}/models/{modelId}/items/{itemId}

Playground

Server

Authorization

api_token

Variables

Key

Value

orgaId*

modelId*

itemId*

Samples

cURL

JavaScript

PHP

Python

---

Add data values to item

POST

/organizations/{orgaId}/models/{modelId}/items/{itemId}/data-values

Add data values to item. This method is used in the context of a repeater where a user can add new data rows resulting in data values.

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

orgaId*

The id of the organization you are a member of.

Typestring

Required

formatuuid

modelId*

The id of the model. A item always belongs to a model.

Typestring

Required

formatuuid

itemId*

The id of the item.

Typestring

Required

formatuuid

Request Body

application/json

[

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

]

Responses

Content-Type

application/json

{

"id": "string",

"uniqueProductIdentifiers": [

{

"uuid": "string",

"value": "string"

}

],

"templateId": "string",

"dataValues": [

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

]

}

POST

/organizations/{orgaId}/models/{modelId}/items/{itemId}/data-values

Playground

Server

Authorization

api_token

Variables

Key

Value

orgaId*

modelId*

itemId*

Body

Samples

cURL

JavaScript

PHP

Python

---

Modify data values of item

PATCH

/organizations/{orgaId}/models/{modelId}/items/{itemId}/data-values

Modify data values of item.

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

orgaId*

The id of the organization you are a member of.

Typestring

Required

formatuuid

modelId*

The id of the model. A item always belongs to a model.

Typestring

Required

formatuuid

itemId*

The id of the item.

Typestring

Required

formatuuid

Request Body

application/json

[

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

]

Responses

Content-Type

application/json

{

"id": "string",

"uniqueProductIdentifiers": [

{

"uuid": "string",

"value": "string"

}

],

"templateId": "string",

"dataValues": [

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

]

}

PATCH

/organizations/{orgaId}/models/{modelId}/items/{itemId}/data-values

Playground

Server

Authorization

api_token

Variables

Key

Value

orgaId*

modelId*

itemId*

Body

Samples

cURL

JavaScript

PHP

Python

---

Models

Operations

GET/organizations/{orgaId}/modelsPOST/organizations/{orgaId}/modelsGET/organizations/{orgaId}/models/{modelId}PATCH/organizations/{orgaId}/models/{modelId}POST/organizations/{orgaId}/models/{modelId}/data-valuesPATCH/organizations/{orgaId}/models/{modelId}/data-values

---

Find models of organization

GET

/organizations/{orgaId}/models

Find all models which belong to the provided organization.

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

orgaId*

The id of the organization you are a member of.

Typestring

Required

formatuuid

Responses

Content-Type

application/json

[

{

"id": "string",

"name": "string",

"description": "string",

"uniqueProductIdentifiers": [

{

"uuid": "string",

"value": "string"

}

],

"templateId": "string",

"dataValues": [

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

],

"owner": "string"

}

]

GET

/organizations/{orgaId}/models

Playground

Server

Authorization

api_token

Variables

Key

Value

orgaId*

Samples

cURL

JavaScript

PHP

Python

---

Create model

POST

/organizations/{orgaId}/models

Create a model

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

orgaId*

The id of the organization you are a member of.

Typestring

Required

formatuuid

Request Body

application/json

{

"name": "string",

"description": "string",

"templateId": "string",

"marketplaceResourceId": "string"

}

Responses

Content-Type

application/json

{

"id": "string",

"name": "string",

"description": "string",

"uniqueProductIdentifiers": [

{

"uuid": "string",

"value": "string"

}

],

"templateId": "string",

"dataValues": [

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

],

"owner": "string"

}

POST

/organizations/{orgaId}/models

Playground

Server

Authorization

api_token

Variables

Key

Value

orgaId*

Body

Samples

cURL

JavaScript

PHP

Python

---

Find model by id

GET

/organizations/{orgaId}/models/{modelId}

Find model by id.

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

orgaId*

The id of the organization you are a member of.

Typestring

Required

formatuuid

modelId*

The id of the model. A item always belongs to a model.

Typestring

Required

formatuuid

Responses

Content-Type

application/json

{

"id": "string",

"name": "string",

"description": "string",

"uniqueProductIdentifiers": [

{

"uuid": "string",

"value": "string"

}

],

"templateId": "string",

"dataValues": [

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

],

"owner": "string"

}

GET

/organizations/{orgaId}/models/{modelId}

Playground

Server

Authorization

api_token

Variables

Key

Value

orgaId*

modelId*

Samples

cURL

JavaScript

PHP

Python

---

Update model

PATCH

/organizations/{orgaId}/models/{modelId}

Update model's name and description.

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

orgaId*

The id of the organization you are a member of.

Typestring

Required

formatuuid

modelId*

The id of the model. A item always belongs to a model.

Typestring

Required

formatuuid

Request Body

application/json

{

"name": "string",

"description": "string",

"templateId": "string",

"marketplaceResourceId": "string"

}

Responses

Content-Type

application/json

{

"id": "string",

"name": "string",

"description": "string",

"uniqueProductIdentifiers": [

{

"uuid": "string",

"value": "string"

}

],

"templateId": "string",

"dataValues": [

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

],

"owner": "string"

}

PATCH

/organizations/{orgaId}/models/{modelId}

Playground

Server

Authorization

api_token

Variables

Key

Value

orgaId*

modelId*

Body

Samples

cURL

JavaScript

PHP

Python

---

Add data values to model

POST

/organizations/{orgaId}/models/{modelId}/data-values

Add data values to model. This method is used in the context of a repeater where a user can add new data rows resulting in data values.

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

orgaId*

The id of the organization you are a member of.

Typestring

Required

formatuuid

modelId*

The id of the model. A item always belongs to a model.

Typestring

Required

formatuuid

Request Body

application/json

[

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

]

Responses

Content-Type

application/json

{

"id": "string",

"name": "string",

"description": "string",

"uniqueProductIdentifiers": [

{

"uuid": "string",

"value": "string"

}

],

"templateId": "string",

"dataValues": [

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

],

"owner": "string"

}

POST

/organizations/{orgaId}/models/{modelId}/data-values

Playground

Server

Authorization

api_token

Variables

Key

Value

orgaId*

modelId*

Body

Samples

cURL

JavaScript

PHP

Python

---

Modify data values of model

PATCH

/organizations/{orgaId}/models/{modelId}/data-values

Modify data values of model.

Authorizations

api_token

API key authentication

TypeAPI Key (header: api_token)

Parameters

Path Parameters

orgaId*

The id of the organization you are a member of.

Typestring

Required

formatuuid

modelId*

The id of the model. A item always belongs to a model.

Typestring

Required

formatuuid

Request Body

application/json

[

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

]

Responses

Content-Type

application/json

{

"id": "string",

"name": "string",

"description": "string",

"uniqueProductIdentifiers": [

{

"uuid": "string",

"value": "string"

}

],

"templateId": "string",

"dataValues": [

{

"value": "string",

"dataSectionId": "string",

"dataFieldId": "string",

"row": 0

}

],

"owner": "string"

}

PATCH

/organizations/{orgaId}/models/{modelId}/data-values

Playground

Server

Authorization

api_token

Variables

Key

Value

orgaId*

modelId*

Body

Samples

cURL

JavaScript

PHP

Python

---

Powered by VitePress OpenAPI