IntegrationProcessor
These endpoints are used to connect Design Editor to the storage through the ExternalStateService settings. See Design Editor config reference for more details.
Pull
Loads design from storage (private or public)
At first it tries to find design in public storage, and if it is not found, checks private storage for specified design owner.
Request
GET /api/processor/v1/integration/pull/{tenantId}/{userId}/{designId}Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *tenantId | path | Tenant identifier |
||
| *userId | path | Design owner identifier |
||
| *designId | path | Design identifier |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | string | Success |
|
| 404 |
|
Not Found |
|
| 401 | Unauthorized |
||
| 403 | Forbidden |
Push
Saves design to private storage
If design with specified identifier is not found then new design will be created using provided identifier
Request
POST /api/processor/v1/integration/push/{tenantId}/{userId}/{designId}Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *tenantId | path | Tenant identifier |
||
| *userId | path | Design owner identifier |
||
| *designId | path | Design identifier |
||
| *uploadedFile | formData | Design source file |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
Success |
|
| 401 | Unauthorized |
||
| 403 | Forbidden |
Definitions
ProblemDetails
These endpoints are used to connect Design Editor to the storage through the ExternalStateService settings. See Design Editor config reference for more details.
| Name | Type | Notes |
|---|---|---|
| type | string | |
| title | string | |
| status | integer (int32) | |
| detail | string | |
| instance | string |
DesignDto
These endpoints are used to connect Design Editor to the storage through the ExternalStateService settings. See Design Editor config reference for more details.
| Name | Type | Notes |
|---|---|---|
| customFields | object | |
| metadata |
|
|
| hasProblems | boolean | |
| private | boolean | |
| previews | object | |
| size | integer (int64) | |
| folderId | string | |
| tenantId | integer (int32) | |
| id | string | |
| ownerId | string | |
| name | string | |
| lastModified | string (date-time) |
DesignMetadata
| Name | Type | Notes |
|---|---|---|
| surfaces |
|
DesignSurfaceMetadata
| Name | Type | Notes |
|---|---|---|
| width | number (float) | |
| height | number (float) |