Veldtype

Structuur

Systeemvelden

Onveranderlijk en altijd aanwezig

Variabele eigenschappen

Object Properties_{property_name} voor EN tenants

Objecteigenschappen_{property_name} voor NL tenants

Variabele vragenlijsten

{questionnaire_name}_{field_name}

Teken

Toegestaan

Vervangen door

Voorbeeld

Alfanumeriek

Ja

Geen wijzigingen

Geen wijzigingen

Underscore (_)

Ja

Geen wijzigingen

Geen wijzigingen

Streepje (-)

Nee

Underscore (_)

"General - Business Process" met het veld "Beschrijving" wordt vertaald naar "General___Business_Process_Beschrijving"

Spatie ( )

Nee

Underscore (_)

"General - Business Process" met het veld "Business Process owner" wordt vertaald naar "General___Business_Process_Business_Process_owner"

Elk ander teken

Nee

De gecodeerde waarde van het teken (hex-waarde in xXX-formaat).

"General - Business Process" met het veld "Meer info..." wordt vertaald naar "General___Business_Process_More_info_x2Ex2Ex2E"

Veldtype

Vervangen door

Dropdown/Meervoudige selectie

******

Dropdown/Radio

******

Hyperlink

******

Meerdere tekstregels

******

Tekst

******

Opgemaakte tekst

******

Checkbox

Lege string

Datum

Lege string

Nummer

Lege string

Valuta

Lege string

Parameter

Opmerking

$filter

Met filters kun je het aantal objecten beperken dat uit BlueDolphin wordt opgehaald.

Bijvoorbeeld,
get-bdrelation -filter "Name eq 'accesses'"
Geeft alle relaties terug met de naam "benadert". (Meestal bevat het resultaat bij gebruik van de Naam-eigenschap slechts 1 richting)

$orderby

Standaard gebruikt de BlueDolphin OData-feed geen sortering.

Voeg deze parameter toe om een specifieke sorteermethode voor je query te gebruiken.

Let op: Wanneer je een $skip- en $top-reeks gebruikt om alle data op te halen, moet je de $orderby-parameter opgeven, bijvoorbeeld op ID.

$select

Wordt gebruikt om aan te geven welke eigenschappen (velden) van een entiteit moeten worden teruggegeven.
Bijvoorbeeld, $select {"Id", "title"}

$skip

Wordt gebruikt om paginering toe te passen bij het ophalen van gegevens via een GET-methode. Hiermee kun je een subset van entiteiten in een collectie ophalen door een opgegeven aantal items over te slaan.

$top

bijvoorbeeld, als de waarde = 10, dan worden de eerste 10 items teruggegeven.

$count

Alleen van toepassing op de geschiedenis-endpoint

Functie

ends.With

starts.With

contains

Logische operator

Beschrijving

And

Logisch en

Eq

Gelijk aan

Gt

is groter dan

Ge

Groter dan of gelijk aan

Lt

is kleiner dan

Le

Kleiner dan of gelijk aan

Ne

Niet gelijk aan

Or

Logisch of

Eigenschap

Type

Beschrijving

ID

String

De primaire sleutel van het object. Alleen opgeslagen in de database en niet zichtbaar in de UI.

Om inzicht te krijgen in hoe het object is gekoppeld aan een ander object, moet je deze ID koppelen aan "BlueDolphinObjectItemId" en ook aan "RelatedBlueDolphinObjectItemId".

Titel

String

De primaire sleutel van het object. Ook zichtbaar in de UI.

Object compleetheid

integer

Geeft het voltooiingspercentage terug van vragenlijstvelden die gemarkeerd zijn als 'Gebruik in compleetheidsberekening' en die zijn ingevuld.

CreatedOn

String

De timestamp van de aanmaak in ISO 8601 UTC-formaat

CreatedBy

String

De naam van de gebruiker die het object heeft aangemaakt

ChangedOn

String

De timestamp van de wijziging in ISO 8601 UTC-formaat.

Niet ingevuld als een object alleen is aangemaakt.

ChangedBy

String

De naam van de gebruiker die de wijziging heeft doorgevoerd.

Niet ingevuld als het object alleen is aangemaakt.

ArchivedOn

String

Alleen ingevuld als het object is verwijderd. De status van het object moet 'Archived' zijn.

ArchivedBy

String

Alleen ingevuld als het object is verwijderd. De status van het object moet 'Archived' zijn.

ArchimateType

String

De naam van het onderliggende ArchiMate® type (waarop de objectdefinitie is gebaseerd). Kan niet worden gewijzigd in BlueDolphin.

Objectdefinitie

String

Je eigen aangepaste naam van het ArchiMate-type

Categorie

String

De categorie van het object. Kan niet worden gewijzigd in BlueDolphin.

ConditionalColor

String

De hexadecimale kleurcode van het object. Bij aanmaak wordt een willekeurige code toegekend, maar deze kan op elk moment worden aangepast.

Status

String

Geeft aan of het object 'Accepted' of 'Archived' is. Wil je de huidige informatie ophalen, kies dan 'Accepted'. Wil je verwijderde objecten ophalen, kies dan 'Archived'.

ObjectLifecycleState

String

De lifecycle-status kan Huidig of Toekomstig zijn.

Workspace

String

De naam van het bedrijfsonderdeel. Als de functionaliteit voor bedrijfsonderdelen niet is ingeschakeld, is de waarde altijd hetzelfde - de bedrijfsnaam zoals getoond in de UI.

Objecteigenschappen_Naam

String

Als de eigenschap begint met "Objecteigenschappen", betreft het informatie van "Objecteigenschappen" en niet van "Vragenlijst".

General___Application_More_Info_x2Ex2Ex2E

Afhankelijk van het type veld:

Eigenschap

Type

Beschrijving

Id

String

Unieke identificatie voor de relatie

RelationshipId

String

Unieke identificatie voor de objectcombinatie

BlueDolphinObjectItemId

String

Unieke identificatie voor het object waar de relatie vandaan komt. Gebruik deze ID om te koppelen aan een object-ID.

RelatedBlueDolphinObjectItemId

String

Unieke identificatie voor het object waar de relatie naartoe gaat.

Gebruik deze ID om te koppelen aan een object-ID en het gerelateerde object te vinden.

RelationshipDefinitionId

String

Unieke identificatie voor de relatiedefinitie

RelationshipDefinitionName

String

De naam van de relatie zoals getoond in het veld "Naam" in de UI

BlueDolphinObjectWorkspaceName

String

De naam van de werkset waar het "van" of "bron" object zich bevindt

BlueDolphinObjectDefinitionName

String

De naam van de definitie van het "van" of "bron" object

RelatedBlueDolphinObjectWorkspaceName

String

De naam van de werkset waar het "naar" of "doel" object zich bevindt

RelatedBlueDolphinObjectDefinitionName

String

De naam van de definitie van het "naar" of "doel" object

Type

String

Het type van de relatie zoals getoond in het veld "Gebaseerd op" in de UI

Name

String

De naam van de relatie. Er zijn twee mogelijke waarden voor elk relatietype, bijvoorbeeld 'aggregeert' en 'geaggregeerd door'.

IsRelationshipDirectionAlternative

Boolean

Geeft aan of de richting van de relatie alternatief is. Mogelijke waarden zijn TRUE of FALSE, maar meestal wordt FALSE gebruikt.

Status

String

Geeft de status van de relatie aan. Mogelijke waarden zijn:

Remark

String

Het label van de relatie

Description

String

Geeft een lege string terug in een response

CreatedBy

String

De naam van de gebruiker die de relatie heeft aangemaakt

CreatedOn

String

De timestamp van het aanmaken in ISO 8601 UTC-formaat

ChangedBy

String

De naam van de gebruiker die de wijziging heeft gedaan

ChangedOn

String

De timestamp van de wijziging in ISO 8601 UTC-formaat

RelationshipLifecycleState

String

De lifecycle-status kan Huidig of Toekomstig zijn.

Eigenschap

Type

Beschrijving

Id

ObjectId

Unieke identificatie voor de werkset

Naam

String

Naam van de werkset

DraftType

String

Of de werkset gedeeld is of niet:

DraftMainType

String

Type werkset:

Status

String

Dit is altijd "Ready".

WorkspaceId

String

ID van de Workspace

ProjectId (indien beschikbaar)

String

ID van het Project waarmee deze werkset geassocieerd is, indien van toepassing.
(kan linken naar de Projecten dataset)

OwnerId

String

ID van de gebruiker die de eigenaar is van de werkset (kan linken naar de Gebruikers dataset)

CreatedAt

DateTime

Datum en tijd waarop deze werkset is aangemaakt

UpdatedAt

DateTime

Datum en tijd waarop deze werkset is aangemaakt

IsPublic

Boolean

Geeft aan of de werkset openbaar (true) of privé (false) is

CollaboratorsCount (exclusief eigenaar)

Integer

Aantal gebruikers waarmee deze werkset gedeeld is

NodesCount

Integer

Aantal objecten dat op deze werkset staat

Eigenschap

Type

Beschrijving

NodeKey

String

Unieke identificatie voor het object op de werkset

ViewId

String

ID van de Werkset (kan linken naar de Werksets dataset)

ObjectId

String

ID van het Object (kan linken naar de Objecten dataset)

ObjectTypeId

String

ID van het type van het object

Titel

String

Objecttitel

Eigenschap

Type

Beschrijving

DiagramId

Long

Unieke identificatie van het diagram.

DiagramName

String

Titel van het diagram.

ConnectedProcessId

String

Unieke identificatie van het procesobject dat aan het diagram is gekoppeld. null als er geen proces is gekoppeld.

ConnectedProcessName

String

Titel van het procesobject dat aan het diagram is gekoppeld. null als er geen proces is gekoppeld.

Owner

String

Naam van de gebruiker die het diagram als eigenaar heeft.

OwnerId

String

ID van de gebruiker die het diagram als eigenaar heeft.

CreatedBy

String

Naam van de gebruiker die het diagram heeft aangemaakt.

CreatedOn

DateTime

Datum en tijd waarop het diagram is aangemaakt.

LastEdited

DateTime

Datum en tijd waarop het diagram het laatst bewerkt is.

WorkspaceId

String

ID van de werkruimte waar het diagram bij hoort.

PublicationStatus

String

De huidige status: Concept of Gepubliceerd.

PublicationDate

DateTime

Datum en tijd waarop het diagram voor het laatst is gepubliceerd (null bij concepten).

PublishedBy

String

Naam van de gebruiker die het diagram heeft gepubliceerd (null bij concepten).

Eigenschap

Type

Beschrijving

Id

String

Unieke sleutel van het record, samengesteld als {DiagramId}:{BpmnElementId}:{RelatedObjectId} (leeg als het element geen gekoppeld object heeft).

DiagramId

Long

Unieke identificatie voor het diagram.

DiagramName

String

De titel van het gekoppelde procesobject, of de diagramtitel als er geen proces is gekoppeld.

ConnectedProcessId

String

Unieke identificatie van het procesobject dat aan het diagram is gekoppeld.

ConnectedProcessName

String

Titel van het procesobject dat aan het diagram is gekoppeld.

BpmnElementId

String

Unieke identificatie voor het specifieke element op het canvas.

TaskEventName

String

De naam van de taak of gebeurtenis.

TaskEventType

String

Het BPMN-elementtype als een duidelijke label (bijv. User Task, End Event).

RelatedLane

String

De lane waarin het element zich bevindt.

RelatedRole

String

De rol geassocieerd met het element (via het gekoppelde Bedrijfsrol-object van de lane/deelnemer).

RelatedActor

String

De actor geassocieerd met het element (via het gekoppelde Bedrijfsactor-object van de lane/deelnemer).

RelatedObjectId

String

Unieke identificatie van het gekoppelde EA-object (indien van toepassing).

RelatedObjectTitle

String

Titel van het gekoppelde EA-object.

RelatedObjectDefinition

String

Definitie-ID van het gekoppelde EA-object.

RelatedObjectType

String

Objecttype van het gekoppelde EA-object.

RelatedObjectIsActive

Boolean

Geeft aan of het gekoppelde EA-object actief is. TRUE als het object is geaccepteerd, FALSE als het is gearchiveerd. Leeg als het element geen gekoppeld object heeft.

Beschrijving

String

De beschrijving van het element, zoals ingevoerd bij de eigenschappen.

Hyperlink

String

De hyperlink die is ingevoerd bij de eigenschappen van het element.

PublicationStatus

String

De huidige status: Concept of Gepubliceerd.

PublicationDate

DateTime

Wanneer het diagram voor het laatst is gepubliceerd (null bij concepten).

PublishedBy

String

De gebruiker die het diagram heeft gepubliceerd (null bij concepten).

Eigenschap

Type

Beschrijving

Id

String

Unieke sleutel van het record, samengesteld als {DiagramId}:{link id}.

DiagramID

Long

Unieke identificatie van het diagram.

DiagramName

String

Naam van het diagram — de titel van het gekoppelde procesobject, of anders de diagramtitel.

ConnectedProcessId

String

Unieke identificatie van het proces.

ConnectedProcessName

String

Naam van het proces.

BpmnObjectID

String

Unieke identificatie van het BPMN-object.

BpmnObjectName

String

Naam van het BPMN-object.

WorkspaceId

String

Het ID van het bedrijfsonderdeel (workspace) waar het diagram bij hoort.

RelatedEaObjectID

String

Unieke identificatie van het gerelateerde EA-object.

RelatedEaTitle

String

Titel van het gerelateerde EA-object.

RelatedEaDefinition

String

Definitienaam van het gerelateerde EA-object.

RelatedObjectIsActive

Boolean

Geeft aan of het gekoppelde EA-object actief is. TRUE als het object is geaccepteerd, FALSE als het is gearchiveerd.

Eigenschap

Type

Beschrijving

Id

String

Geschiedenis-id

TargetId

String

Id van het object

ChangedBy

String

De naam van de gebruiker

Action

String

Geeft aan welke actie is uitgevoerd. Mogelijke waarden zijn:

Category

String

Object_relatie

Object_algemeen

object_vragenlijst

Timestamp

String

datum laatste wijziging

FieldId

String

Voor Object_relatie: relatie-id

Object_algemeen: naam van het eigenschapsveld

object_vragenlijst: id van de vraag

Eigenschap

Type

GeneralFieldName

String

GeneralFieldInput

String

GeneralFieldInputOld

String

Eigenschap

Type

Relatie

String

RelationshipOld

String

Label

String

LabelOld

String

ToObject

String

ToObjectOld

String

ToObjectId

String

ToObjectOldId

String

Eigenschap

Type

QuestionFieldName

String

QuestionFieldNameOld

String

QuestionFieldInput

String

QuestionFieldInputOld

String

QuestionnaireId

String

QuestionnaireName

String

Eigenschap

Type

ActionsDescription

String

ActionsValue

String

ActionsValueOld

String

Eigenschap

Type

ObjectsObject

String

Eigenschap

Type

RelationshipsRelationship

String

RelationshipsFrom

String

RelationshipsTo

String

Eigenschap

Type

DataobjectTermsKeysDataObject

String

DataobjectTermsKeysTerm

String

DataobjectTermsKeysKey

String

DataobjectTermsKeysKeyOld

String

Eigenschap

Type

DataconnectionsFromObject

String

DataconnectionsFromObjectOld

String

DataconnectionsToObject

String

DataconnectionsToObjectOld

String

DataconnectionsFrom

String

DataconnectionsFromOld

String

DataconnectionsTo

String

DataconnectionsToOld

String

Eigenschap

Type

LinesLine

String

LinesLineOld

String

LinesFrom

String

LinesFromOld

String

LinesTo

String

LinesToOld

String

LinesText

String

LinesTextOld

String

Eigenschap

Type

ShapesShape

String

ShapesText

String

ShapesTextOld

String

Eigenschap

Type

Beschrijving

Naam

String

De naam van de tenant in de database

Customername

String

De weergavenaam van de tenant die zichtbaar is in de gebruikersinterface

Taal

String

Geeft aan of de taal van de tenant Engels (EN) of Nederlands (NL) is

Eigenschap

Type

Beschrijving

ID

ObjectId

Unieke identificatie voor het record/project-id

WorkspaceId

ObjectId

ID van de gekoppelde workspace

OwnerId

ObjectId

ID van de eigenaar

OwnerFirstName

String

Voornaam van de eigenaar

OwnerLastName

String

Achternaam van de eigenaar

Titel

String

Titel van het item

Beschrijving

String

Beschrijving van het item

Status

Enum (String)

Status opgeslagen in het Engels

CreatedOn

Datum

Aanmaakdatum

ChangedOn

Datum

Datum van laatste wijziging

StartDate

Datum

Startdatum van het item

EndDate

Datum

Einddatum van het item

DeliverableCount

Nummer

Aantal deliverables

PhaseCount

Nummer

Aantal fases

CollaboratorsCount

Nummer

Aantal samenwerkers

Eigenschap

Type

Beschrijving

Id

ObjectId

Unieke identificatie voor de deliverable (deliverableId)

PhaseId

String

ID van de gekoppelde fase

ProjectId

String

ID van het gekoppelde project

WorkspaceId

String

ID van de workspace (mogelijk niet nodig)

DeliverableTitle

String

Titel van de deliverable

PhaseTitle

String

Titel van de gekoppelde fase

ResourceId

String

Identificatie van het gekoppelde bedrijfsmiddel (mag leeg zijn)

ResourceType

String

Type bedrijfsmiddel (opgeslagen in het Engels)

ResourceUrl

String

URL van het bedrijfsmiddel (functie nog niet geïmplementeerd)

UrlDisplayName

String

Weergavenaam voor het bedrijfsmiddel van het type URL

AssigneeId

String

ID van de gebruiker die als verantwoordelijke is toegewezen aan de deliverable

AssigneeFirstName

String

Voornaam van de gebruiker die als verantwoordelijke is toegewezen aan de deliverable

AssigneeLastName

String

Achternaam van de gebruiker die als verantwoordelijke is toegewezen aan de deliverable

IsFlagged

Boolean

Geeft aan of de deliverable als Vlag is gemarkeerd

Deadline

Date

Datum van de deadline die op een deliverable is ingesteld

Eigenschap

Type

Beschrijving

Id

String

De technische Id van de gebruiker

FirstName

String

De voornaam van de gebruiker

LastName

String

De achternaam van de gebruiker

Email

String

Het e-mailadres van de gebruiker

Status

String

Beschrijving van de uitnodigingsstatus.
Voor SSO-gebruikers is dit meestal leeg

IsGuestUser

Boolean

Geeft aan of de gebruiker een gastgebruiker is. Een gastgebruiker wordt alleen toegevoegd via de SSO-koppeling en heeft geen zichtbaar account in BlueDolphin.

Deze gebruikers kunnen alleen het procesportaal (oud/nieuw) benaderen.

Eigenschap

Type

Beschrijving

Id

String

De technische Id van de rol

Name

String

De naam van de rol

InternalName

String

De interne naam van de rol. Dit geeft een GUID terug voor zelf aangemaakte rollen. De ingebouwde rollen tonen een leesbare naam.

Beschrijving

String

De beschrijving van de rol, ingesteld door een Admin.

DefaultLandingPage

String

De landingspagina van deze rol (toegevoegd na bluedolphin.app/<tenant>/)

IsBuiltin

Boolean

Als dit waar is, is dit een ingebouwde en verplichte rol.

Eigenschap

Type

Beschrijving

Id

String

De technische id van de rol

Naam

String

De naam van de Rol

ObjectDefinitionId

String

De technische id van de objectdefinitie

ObjectDefinitionName

String

De naam van de objectdefinitie

PermissionName

String

De naam van de permissie

PermissionAccess

String

De rechten die bij de permissie horen voor deze objectdefinitie binnen deze rol

Eigenschap

Type

Beschrijving

Id

String

De technische Id van deze relatie

UserId

String

De technische Id van een gebruiker.
Deze kan gebruikt worden om te koppelen aan “Gebruikers”

RoleId

String

De technische Id van een rol.
Deze kan gebruikt worden om te koppelen aan “Rollen” of “RolesPermissions”-feeds