AlphaAlpha Docs
API Reference

Configuration

Controller for managing configurations, including creating, updating, and retrieving configurations.

Download Csv_ Configuration

GET
/configurations/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/configurations/csv-export"
"string"
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete a list of entities by their IDs

DELETE
/configurations/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/configurations/delete-list?ids=string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search_ Configuration

GET
/configurations/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/configurations/dynamic-search"
{
  "content": [
    {
      "choices": [
        {
          "code": "string",
          "option": "string"
        }
      ],
      "chosenVariables": [
        {
          "id": "string",
          "value": 0.1
        }
      ],
      "clientId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "duration": 0,
      "errorMessage": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "favorite": true,
      "files": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "houseId": "string",
      "id": "string",
      "lockedAt": "2019-08-24T14:15:22Z",
      "lockedBy": "string",
      "message": "string",
      "note": "string",
      "previousFiles": {
        "property1": [
          {
            "blobId": "string",
            "created": "2019-08-24T14:15:22Z",
            "extension": "string",
            "fileSize": 0,
            "name": "string",
            "type": "IMAGE"
          }
        ],
        "property2": [
          {
            "blobId": "string",
            "created": "2019-08-24T14:15:22Z",
            "extension": "string",
            "fileSize": 0,
            "name": "string",
            "type": "IMAGE"
          }
        ]
      },
      "priority": 0,
      "progress": 0.1,
      "projectId": "string",
      "source": "INTERNAL",
      "status": "REQUEST",
      "tenantId": "string",
      "typeId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "version": 0
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search Post_ Configuration

POST
/configurations/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/configurations/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "choices": [
        {
          "code": "string",
          "option": "string"
        }
      ],
      "chosenVariables": [
        {
          "id": "string",
          "value": 0.1
        }
      ],
      "clientId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "duration": 0,
      "errorMessage": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "favorite": true,
      "files": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "houseId": "string",
      "id": "string",
      "lockedAt": "2019-08-24T14:15:22Z",
      "lockedBy": "string",
      "message": "string",
      "note": "string",
      "previousFiles": {
        "property1": [
          {
            "blobId": "string",
            "created": "2019-08-24T14:15:22Z",
            "extension": "string",
            "fileSize": 0,
            "name": "string",
            "type": "IMAGE"
          }
        ],
        "property2": [
          {
            "blobId": "string",
            "created": "2019-08-24T14:15:22Z",
            "extension": "string",
            "fileSize": 0,
            "name": "string",
            "type": "IMAGE"
          }
        ]
      },
      "priority": 0,
      "progress": 0.1,
      "projectId": "string",
      "source": "INTERNAL",
      "status": "REQUEST",
      "tenantId": "string",
      "typeId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "version": 0
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by list of ids in current tenant

GET
/configurations/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/configurations/find?ids=string"
[
  {
    "choices": [
      {
        "code": "string",
        "option": "string"
      }
    ],
    "chosenVariables": [
      {
        "id": "string",
        "value": 0.1
      }
    ],
    "clientId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "duration": 0,
    "errorMessage": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "favorite": true,
    "files": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "houseId": "string",
    "id": "string",
    "lockedAt": "2019-08-24T14:15:22Z",
    "lockedBy": "string",
    "message": "string",
    "note": "string",
    "previousFiles": {
      "property1": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "property2": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ]
    },
    "priority": 0,
    "progress": 0.1,
    "projectId": "string",
    "source": "INTERNAL",
    "status": "REQUEST",
    "tenantId": "string",
    "typeId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "version": 0
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find all for current tenant

GET
/configurations/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/configurations/find-all"
[
  {
    "choices": [
      {
        "code": "string",
        "option": "string"
      }
    ],
    "chosenVariables": [
      {
        "id": "string",
        "value": 0.1
      }
    ],
    "clientId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "duration": 0,
    "errorMessage": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "favorite": true,
    "files": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "houseId": "string",
    "id": "string",
    "lockedAt": "2019-08-24T14:15:22Z",
    "lockedBy": "string",
    "message": "string",
    "note": "string",
    "previousFiles": {
      "property1": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "property2": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ]
    },
    "priority": 0,
    "progress": 0.1,
    "projectId": "string",
    "source": "INTERNAL",
    "status": "REQUEST",
    "tenantId": "string",
    "typeId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "version": 0
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find a list of entities by their IDs

GET
/configurations/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/configurations/find-list"
[
  {
    "choices": [
      {
        "code": "string",
        "option": "string"
      }
    ],
    "chosenVariables": [
      {
        "id": "string",
        "value": 0.1
      }
    ],
    "clientId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "duration": 0,
    "errorMessage": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "favorite": true,
    "files": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "houseId": "string",
    "id": "string",
    "lockedAt": "2019-08-24T14:15:22Z",
    "lockedBy": "string",
    "message": "string",
    "note": "string",
    "previousFiles": {
      "property1": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "property2": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ]
    },
    "priority": 0,
    "progress": 0.1,
    "projectId": "string",
    "source": "INTERNAL",
    "status": "REQUEST",
    "tenantId": "string",
    "typeId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "version": 0
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get enriched configurations by ID list

GET
/configurations/find-list-enriched

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/configurations/find-list-enriched"
[
  {
    "basePrice": 0.1,
    "choices": [
      {
        "base": true,
        "category": "string",
        "code": "string",
        "description": "string",
        "option": "string",
        "phase": "PLAN",
        "price": 0.1
      }
    ],
    "clientEmail": "string",
    "clientId": "string",
    "clientName": "string",
    "conceptName": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "duration": 0,
    "errorMessage": "string",
    "favorite": true,
    "files": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "houseId": "string",
    "id": "string",
    "lockedAt": "2019-08-24T14:15:22Z",
    "lockedBy": "string",
    "message": "string",
    "priority": 0,
    "progress": 0.1,
    "projectId": "string",
    "projectName": "string",
    "source": "INTERNAL",
    "status": "REQUEST",
    "totalPrice": 0.1,
    "typeId": "string",
    "typeName": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by id in current tenant

GET
/configurations/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/configurations/find/string"
{
  "choices": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "chosenVariables": [
    {
      "id": "string",
      "value": 0.1
    }
  ],
  "clientId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "errorMessage": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "favorite": true,
  "files": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "houseId": "string",
  "id": "string",
  "lockedAt": "2019-08-24T14:15:22Z",
  "lockedBy": "string",
  "message": "string",
  "note": "string",
  "previousFiles": {
    "property1": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "property2": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ]
  },
  "priority": 0,
  "progress": 0.1,
  "projectId": "string",
  "source": "INTERNAL",
  "status": "REQUEST",
  "tenantId": "string",
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "version": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get next configuration job

GET
/configurations/next-job

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/configurations/next-job"
{
  "choices": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "chosenVariables": [
    {
      "id": "string",
      "value": 0.1
    }
  ],
  "clientId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "errorMessage": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "favorite": true,
  "files": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "houseId": "string",
  "id": "string",
  "lockedAt": "2019-08-24T14:15:22Z",
  "lockedBy": "string",
  "message": "string",
  "note": "string",
  "previousFiles": {
    "property1": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "property2": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ]
  },
  "priority": 0,
  "progress": 0.1,
  "projectId": "string",
  "source": "INTERNAL",
  "status": "REQUEST",
  "tenantId": "string",
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "version": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/configurations/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/configurations/page"
{
  "content": [
    {
      "choices": [
        {
          "code": "string",
          "option": "string"
        }
      ],
      "chosenVariables": [
        {
          "id": "string",
          "value": 0.1
        }
      ],
      "clientId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "duration": 0,
      "errorMessage": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "favorite": true,
      "files": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "houseId": "string",
      "id": "string",
      "lockedAt": "2019-08-24T14:15:22Z",
      "lockedBy": "string",
      "message": "string",
      "note": "string",
      "previousFiles": {
        "property1": [
          {
            "blobId": "string",
            "created": "2019-08-24T14:15:22Z",
            "extension": "string",
            "fileSize": 0,
            "name": "string",
            "type": "IMAGE"
          }
        ],
        "property2": [
          {
            "blobId": "string",
            "created": "2019-08-24T14:15:22Z",
            "extension": "string",
            "fileSize": 0,
            "name": "string",
            "type": "IMAGE"
          }
        ]
      },
      "priority": 0,
      "progress": 0.1,
      "projectId": "string",
      "source": "INTERNAL",
      "status": "REQUEST",
      "tenantId": "string",
      "typeId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "version": 0
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get enriched configuration page

GET
/configurations/page-enriched

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/configurations/page-enriched"
{
  "content": [
    {
      "basePrice": 0.1,
      "choices": [
        {
          "base": true,
          "category": "string",
          "code": "string",
          "description": "string",
          "option": "string",
          "phase": "PLAN",
          "price": 0.1
        }
      ],
      "clientEmail": "string",
      "clientId": "string",
      "clientName": "string",
      "conceptName": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "duration": 0,
      "errorMessage": "string",
      "favorite": true,
      "files": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "houseId": "string",
      "id": "string",
      "lockedAt": "2019-08-24T14:15:22Z",
      "lockedBy": "string",
      "message": "string",
      "priority": 0,
      "progress": 0.1,
      "projectId": "string",
      "projectName": "string",
      "source": "INTERNAL",
      "status": "REQUEST",
      "totalPrice": 0.1,
      "typeId": "string",
      "typeName": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Add House Configuration

POST
/configurations/public/{tenantId}/{projectId}/{houseId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string
projectId*string
houseId*string

Query Parameters

scenarioId?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/configurations/public/string/string/string" \  -H "Content-Type: application/json" \  -d '{    "buyer": {      "email": "string",      "name": "string"    },    "choices": [      {        "code": "string",        "option": "string"      }    ],    "chosenVariables": [      {        "id": "string",        "value": 0.1      }    ],    "source": "INTERNAL"  }'
{
  "assignedConfigurationId": "string",
  "baseConfiguration": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "basePrice": 0.1,
  "buyer": {
    "address": {
      "city": "string",
      "country": "string",
      "houseNumber": "string",
      "id": "string",
      "latitude": 0.1,
      "longitude": 0.1,
      "postalCode": "string",
      "street": "string"
    },
    "clientId": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
  },
  "choices": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "chosenVariables": [
    {
      "id": "string",
      "value": 0.1
    }
  ],
  "cost": 0.1,
  "id": "string",
  "modelInstances": [
    {
      "configuredFacadeId": "string",
      "modelId": "string"
    }
  ],
  "optionPrice": 0.1,
  "ownershipType": "RENTED",
  "planOptions": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "potentialConfigurations": [
    "string"
  ],
  "profit": 0.1,
  "saleRevenue": 0.1,
  "status": "AVAILABLE",
  "typeId": "string",
  "variantId": "string",
  "views": [
    {
      "frequency": 0,
      "ip": "string",
      "time": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Calculate Configurator Data

POST
/configurations/public/{tenantId}/{projectId}/{houseId}/calculate-configurator-data

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string
projectId*string
houseId*string

Query Parameters

scenarioId?string
extension?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/configurations/public/string/string/string/calculate-configurator-data" \  -H "Content-Type: application/json" \  -d '{    "choices": [      {        "code": "string",        "option": "string"      }    ]  }'
{
  "basePrice": 0.1,
  "choices": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "houseId": "string",
  "models": [
    {
      "blob": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "name": "string",
      "position": {
        "x": 0.1,
        "y": 0.1,
        "z": 0.1
      },
      "rotation": {
        "x": 0.1,
        "y": 0.1,
        "z": 0.1
      }
    }
  ],
  "optionsGroupedByCategory": {
    "property1": [
      {
        "category": "string",
        "codes": [
          {
            "code": "string",
            "description": "string",
            "message": "string",
            "price": 0.1,
            "valid": true
          }
        ],
        "option": "string",
        "phase": "PLAN"
      }
    ],
    "property2": [
      {
        "category": "string",
        "codes": [
          {
            "code": "string",
            "description": "string",
            "message": "string",
            "price": 0.1,
            "valid": true
          }
        ],
        "option": "string",
        "phase": "PLAN"
      }
    ]
  },
  "status": "AVAILABLE",
  "typeId": "string",
  "views": [
    {
      "active": true,
      "description": "string",
      "id": "string",
      "position": {
        "x": 0.1,
        "y": 0.1,
        "z": 0.1
      },
      "target": {
        "x": 0.1,
        "y": 0.1,
        "z": 0.1
      }
    }
  ]
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get enriched configuration

GET
/configurations/{configurationId}/enriched

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

configurationId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/configurations/string/enriched"
{
  "basePrice": 0.1,
  "choices": [
    {
      "base": true,
      "category": "string",
      "code": "string",
      "description": "string",
      "option": "string",
      "phase": "PLAN",
      "price": 0.1
    }
  ],
  "clientEmail": "string",
  "clientId": "string",
  "clientName": "string",
  "conceptName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "errorMessage": "string",
  "favorite": true,
  "files": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "houseId": "string",
  "id": "string",
  "lockedAt": "2019-08-24T14:15:22Z",
  "lockedBy": "string",
  "message": "string",
  "priority": 0,
  "progress": 0.1,
  "projectId": "string",
  "projectName": "string",
  "source": "INTERNAL",
  "status": "REQUEST",
  "totalPrice": 0.1,
  "typeId": "string",
  "typeName": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Fail configuration job

POST
/configurations/{configurationId}/fail/{workerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

configurationId*string
workerId*string

Query Parameters

reason?string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/configurations/string/fail/string"
{
  "choices": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "chosenVariables": [
    {
      "id": "string",
      "value": 0.1
    }
  ],
  "clientId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "errorMessage": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "favorite": true,
  "files": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "houseId": "string",
  "id": "string",
  "lockedAt": "2019-08-24T14:15:22Z",
  "lockedBy": "string",
  "message": "string",
  "note": "string",
  "previousFiles": {
    "property1": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "property2": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ]
  },
  "priority": 0,
  "progress": 0.1,
  "projectId": "string",
  "source": "INTERNAL",
  "status": "REQUEST",
  "tenantId": "string",
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "version": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Finish configuration job

POST
/configurations/{configurationId}/finish/{workerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

configurationId*string
workerId*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/configurations/string/finish/string"
{
  "choices": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "chosenVariables": [
    {
      "id": "string",
      "value": 0.1
    }
  ],
  "clientId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "errorMessage": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "favorite": true,
  "files": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "houseId": "string",
  "id": "string",
  "lockedAt": "2019-08-24T14:15:22Z",
  "lockedBy": "string",
  "message": "string",
  "note": "string",
  "previousFiles": {
    "property1": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "property2": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ]
  },
  "priority": 0,
  "progress": 0.1,
  "projectId": "string",
  "source": "INTERNAL",
  "status": "REQUEST",
  "tenantId": "string",
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "version": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get required files for configuration

GET
/configurations/{configurationId}/required-files

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

configurationId*string

Query Parameters

extension?string
Default"glb"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/configurations/string/required-files"
[
  {
    "blobId": "string",
    "fileSize": 0,
    "name": "string",
    "position": {
      "x": 0.1,
      "y": 0.1,
      "z": 0.1
    },
    "productName": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Retry configuration job

POST
/configurations/{configurationId}/retry

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

configurationId*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/configurations/string/retry"
{
  "choices": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "chosenVariables": [
    {
      "id": "string",
      "value": 0.1
    }
  ],
  "clientId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "errorMessage": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "favorite": true,
  "files": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "houseId": "string",
  "id": "string",
  "lockedAt": "2019-08-24T14:15:22Z",
  "lockedBy": "string",
  "message": "string",
  "note": "string",
  "previousFiles": {
    "property1": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "property2": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ]
  },
  "priority": 0,
  "progress": 0.1,
  "projectId": "string",
  "source": "INTERNAL",
  "status": "REQUEST",
  "tenantId": "string",
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "version": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Skip configuration job

POST
/configurations/{configurationId}/skip

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

configurationId*string

Query Parameters

reason?string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/configurations/string/skip"
{
  "choices": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "chosenVariables": [
    {
      "id": "string",
      "value": 0.1
    }
  ],
  "clientId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "errorMessage": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "favorite": true,
  "files": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "houseId": "string",
  "id": "string",
  "lockedAt": "2019-08-24T14:15:22Z",
  "lockedBy": "string",
  "message": "string",
  "note": "string",
  "previousFiles": {
    "property1": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "property2": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ]
  },
  "priority": 0,
  "progress": 0.1,
  "projectId": "string",
  "source": "INTERNAL",
  "status": "REQUEST",
  "tenantId": "string",
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "version": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Start configuration job

POST
/configurations/{configurationId}/start/{workerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

configurationId*string
workerId*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/configurations/string/start/string"
{
  "choices": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "chosenVariables": [
    {
      "id": "string",
      "value": 0.1
    }
  ],
  "clientId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "errorMessage": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "favorite": true,
  "files": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "houseId": "string",
  "id": "string",
  "lockedAt": "2019-08-24T14:15:22Z",
  "lockedBy": "string",
  "message": "string",
  "note": "string",
  "previousFiles": {
    "property1": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "property2": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ]
  },
  "priority": 0,
  "progress": 0.1,
  "projectId": "string",
  "source": "INTERNAL",
  "status": "REQUEST",
  "tenantId": "string",
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "version": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Update configuration status

PATCH
/configurations/{configurationId}/status/{workerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

configurationId*string
workerId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/configurations/string/status/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "choices": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "chosenVariables": [
    {
      "id": "string",
      "value": 0.1
    }
  ],
  "clientId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "errorMessage": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "favorite": true,
  "files": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "houseId": "string",
  "id": "string",
  "lockedAt": "2019-08-24T14:15:22Z",
  "lockedBy": "string",
  "message": "string",
  "note": "string",
  "previousFiles": {
    "property1": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "property2": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ]
  },
  "priority": 0,
  "progress": 0.1,
  "projectId": "string",
  "source": "INTERNAL",
  "status": "REQUEST",
  "tenantId": "string",
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "version": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Toggle favorite status

PATCH
/configurations/{configurationId}/toggle-favorite

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

configurationId*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/configurations/string/toggle-favorite"
{
  "choices": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "chosenVariables": [
    {
      "id": "string",
      "value": 0.1
    }
  ],
  "clientId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "errorMessage": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "favorite": true,
  "files": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "houseId": "string",
  "id": "string",
  "lockedAt": "2019-08-24T14:15:22Z",
  "lockedBy": "string",
  "message": "string",
  "note": "string",
  "previousFiles": {
    "property1": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "property2": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ]
  },
  "priority": 0,
  "progress": 0.1,
  "projectId": "string",
  "source": "INTERNAL",
  "status": "REQUEST",
  "tenantId": "string",
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "version": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Upload files for configuration job

POST
/configurations/{configurationId}/upload/{workerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

configurationId*string
workerId*string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/configurations/string/upload/string" \  -F files="[\n  \"string\"\n]"
{
  "choices": [
    {
      "code": "string",
      "option": "string"
    }
  ],
  "chosenVariables": [
    {
      "id": "string",
      "value": 0.1
    }
  ],
  "clientId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "errorMessage": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "favorite": true,
  "files": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "houseId": "string",
  "id": "string",
  "lockedAt": "2019-08-24T14:15:22Z",
  "lockedBy": "string",
  "message": "string",
  "note": "string",
  "previousFiles": {
    "property1": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "property2": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ]
  },
  "priority": 0,
  "progress": 0.1,
  "projectId": "string",
  "source": "INTERNAL",
  "status": "REQUEST",
  "tenantId": "string",
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "version": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete by id in current tenant

DELETE
/configurations/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/configurations/string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Add a comment to an entity

POST
/configurations/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/configurations/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Concepts

Previous Page

Contact Form Widget Config

Next Page