List the meta information of a single version.

List the meta information of a single version. Get meta information of process in warehouse.

Security: Any user holding a Bpanda licence for the process space, restricted to the versions the caller may see: an owner, whitelistee, Manager or Designer reaches every version, everyone else only published ones. Workflow diagrams are exempt from that restriction. Blacklisted callers and hidden processes are rejected. An owner, reviewer or optional reviewer of a review of the requested processVersionId, active or closed, may read that version all the same unless blacklisted.

GET/v1/warehouses/{warehouseId}/processes/{processId}/info

Authorization

AuthorizationBearer token (JWT) · headerrequired

BpmLicenseAPI key · headerrequired

Path parameters

warehouseIdstringrequired

ID of warehouse

processIdstringrequired

ID of process

Query parameters

processVersionIdinteger<int32>

ID of process version

Responses

200

Process meta information; Possible "validState" values are UNKNOWN, VALID, INVALID, UPCOMING, GONE

breadcrumbsBreadcrumb[]required

Show properties

Array of Breadcrumb

idstringrequired

namestringrequired

changeSummarystring

descriptionsDescription[]required

Show properties

Array of Description

textFormattedText[]required

Show properties

Array of FormattedText

formatTextFormatrequired

Allowed:BBCodeHTMLPlainText

textstringrequired

titlestringrequired

hasDiagrambooleanrequired

idstringrequired

importedAtstringrequired

importedBystringrequired

lanesAkkuLane[]

Show properties

Array of AkkuLane

groupIdsstring[]required

idstringrequired

namestringrequired

orgIdsstring[]required

orgRoleIdsstring[]required

typestringrequired

userIdsstring[]required

langstringrequired

namestringrequired

presenceTagsPresenceTags

Show properties

changedAtstringrequired

changedBystringrequired

tagsPresenceTag[]required

processStateProcessVersionStatusrequired

Allowed:ABANDONEDAPPROVEDDELETEDIMPORTEDINVALIDIN_REVIEWNOT_PUBLISHEDPUBLISHEDUNKNOWNVALIDWORKFLOWASSIGNED

processVersionNrinteger<int32>required

publicProcessVersionLabelstring

publicProcessVersionNrstring

publishedAtstring

publishedBystring

rolesRoles

Show properties

blacklistedIdsstring[]required

ownerIdsstring[]required

participantIdsstring[]required

whitelistedIdsstring[]required

svgIdstring

thumbnailstring

typestringrequired

validityValidity

Show properties

fromstringrequired

untilstringrequired

validityStateValidityStaterequired

Allowed:GONEINVALIDNEXTPREVIOUSUNKNOWNUPCOMINGVALID

403

Forbidden: insufficient permissions

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*ID of warehouseprocessIdpath*ID of processprocessVersionIdqueryID of process version

Request

curl -X GET 'https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/processes/string/info' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY'

const response = await fetch("https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/processes/string/info", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "BpmLicense": "YOUR_API_KEY"
  }
});

Response

{
  "breadcrumbs": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "changeSummary": "string",
  "descriptions": [
    {
      "text": [
        {
          "format": "BBCode",
          "text": "string"
        }
      ],
      "title": "string"
    }
  ],
  "hasDiagram": true,
  "id": "string",
  "importedAt": "string",
  "importedBy": "string",
  "lanes": [
    {
      "groupIds": [
        "string"
      ],
      "id": "string",
      "name": "string",
      "orgIds": [
        "string"
      ],
      "orgRoleIds": [
        "string"
      ],
      "type": "string",
      "userIds": [
        "string"
      ]
    }
  ],
  "lang": "string",
  "name": "string",
  "presenceTags": {
    "changedAt": "string",
    "changedBy": "string",
    "tags": [
      "PRESENCE_TAG_DEFAULT"
    ]
  },
  "processState": "ABANDONED",
  "processVersionNr": 0,
  "publicProcessVersionLabel": "string",
  "publicProcessVersionNr": "string",
  "publishedAt": "string",
  "publishedBy": "string",
  "roles": {
    "blacklistedIds": [
      "string"
    ],
    "ownerIds": [
      "string"
    ],
    "participantIds": [
      "string"
    ],
    "whitelistedIds": [
      "string"
    ]
  },
  "svgId": "string",
  "thumbnail": "string",
  "type": "string",
  "validity": {
    "from": "string",
    "until": "string"
  },
  "validityState": "GONE"
}

"string"