Show or hide every version of the given elements.

Show or hide every version of the given elements. Shows or hides every version of each of the given architecture elements. Hiding deactivates an element as a whole - it then stays out of every listing, report and export that does not ask for deactivated elements. BusinessProcess elements cannot be hidden; a list containing one is refused as a whole rather than applied in part.

Security: Manager or Designer of the process space, or an owner of the affected architecture element(s).

PUT/v1/warehouses/{warehouseId}/architectureElements/visibility

Authorization

AuthorizationBearer token (JWT) · headerrequired

BpmLicenseAPI key · headerrequired

Path parameters

warehouseIdstringrequired

Warehouse-Id

Query parameters

visiblebooleanrequired

visibility to set. Required - it is a change to the data, not a filter

Request body

requiredapplication/json

ArchitectureElement-ElementIds to show or hide

Array of string

string

Responses

200

List of updated ArchitectureElement-Ids

Array of string

string

403

Forbidden: insufficient permissions

string

404

Warehouse or ArchitectureElement not found

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)API keyRemember on this deviceInclude my values in samples

Parameters

warehouseIdpath*Warehouse-Idvisiblequery*visibility to set. Required - it is a change to the data, not a filter

Bodyapplication/json

Request body

Request

curl -X PUT 'https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/architectureElements/visibility?visible=true' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '[
  "string"
]'

const response = await fetch("https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/architectureElements/visibility?visible=true", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "BpmLicense": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: "[\n  \"string\"\n]"
});

Response

[
  "string"
]

"string"

"string"