AlphaAlpha Docs
API ReferenceConfiguration

Update configuration note

Sets or clears the free-text note for a configuration. Returns the enriched configuration.

PATCH
/configurations/{configurationId}/note
AuthorizationBearer <token>

In: header

Path Parameters

configurationId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

note?string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/configurations/string/note" \  -H "Content-Type: application/json" \  -d '{}'
{
  "additionalOptions": [
    {
      "description": "string",
      "id": "string",
      "position": {
        "x": 0.1,
        "y": 0.1,
        "z": 0.1
      },
      "rotation": {
        "x": 0.1,
        "y": 0.1,
        "z": 0.1
      },
      "type": "WANDCONTACTDOOS"
    }
  ],
  "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",
  "note": "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",
  "variantName": "string",
  "workerEvents": [
    {
      "actor": "string",
      "at": "2019-08-24T14:15:22Z",
      "durationSeconds": 0,
      "message": "string",
      "type": "PICKED_UP"
    }
  ]
}
{
  "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"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}