Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Update a project module

Early access: request API access for your workspace at https://bauhow.com/support before using this endpoint.

Replaces the module payload and/or sets its status. Locked modules reject payload changes.

PATCH/v1/projects/{projectId}/modules/{moduleKey}
Autorisierung
AuthorizationBearer-Token · headererforderlich

Workspace API key (bh_…).

Pfadparameter
projectIdstringerforderlich
min. Länge 1
moduleKeystringerforderlich
Erlaubt:project-informationraumweiseheizlast-huellflaecheverbrauchwaermepumpejazwirtschaftlichkeitfoerderrechnerfoerderwissenschallrechnerchecku-wert-rechnerfoerderservicenachweisservice
Request-Body
application/json
statusstring
Erlaubt:not_starteddraftreadycalculatingcompletedsubmittedlockedfailed
schemaVersioninteger
min. -9007199254740991 · max. 9007199254740991
payloadobject | null
Eigenschaften anzeigen
Mindestens eines von:
object
object
null
null
Antworten
200

OK

idstringerforderlich
projectIdstringerforderlich
moduleKeystringerforderlich
Erlaubt:project-informationraumweiseheizlast-huellflaecheverbrauchwaermepumpejazwirtschaftlichkeitfoerderrechnerfoerderwissenschallrechnerchecku-wert-rechnerfoerderservicenachweisservice
statusstringerforderlich
Erlaubt:not_starteddraftreadycalculatingcompletedsubmittedlockedfailed
schemaVersionintegererforderlich
min. -9007199254740991 · max. 9007199254740991
payloadobject | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
object
object
null
null
validationStateobject | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
object
object
null
null
lockedReasonstring | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
string
string
null
null
lastCompletedAtstring<date-time> | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
string<date-time>
string<date-time>
null
null
createdAtstring<date-time>erforderlich
updatedAtstring<date-time>erforderlich
Ausprobieren
Server
Autorisierung
Parameter
Bodyapplication/json
Anfrage
curl -X PATCH 'https://app.bauhow.com/api/v1/projects/string/modules/project-information' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": "not_started",
  "schemaVersion": -9007199254740991,
  "payload": {
    "property1": null,
    "property2": null
  }
}'
Antwort
{
  "id": "string",
  "projectId": "string",
  "moduleKey": "project-information",
  "status": "not_started",
  "schemaVersion": -9007199254740991,
  "payload": {
    "property1": null,
    "property2": null
  },
  "validationState": {
    "property1": null,
    "property2": null
  },
  "lockedReason": "string",
  "lastCompletedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

War diese Seite hilfreich?