Veldtype

Structuur

Systeemvelden

Onveranderlijk en altijd aanwezig

Variabele eigenschappen

Objecteigenschappen_{property_name} voor NL tenants

Object Properties_{property_name} voor EN 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/Meerdere selecties

******

Dropdown/Radio

******

Hyperlink

******

Meerdere tekstregels

******

Tekst

******

Opgemaakte tekst

******

Checkbox

Lege string

Datum

Lege string

Nummer

Lege string

Valuta

Lege string

Parameter

Opmerking

$filter

Filters kunnen worden ingesteld om het aantal objecten dat uit BlueDolphin wordt opgehaald te beperken.

Bijvoorbeeld,
get-bdrelation -filter "Naam eq 'benadert'"
Geeft alle relaties met de naam "benadert" terug. (Meestal bevat het resultaat bij gebruik van de eigenschap Naam 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", "titel"}

$skip

Wordt gebruikt om paginering toe te passen bij het ophalen van data via een GET-methode. Hiermee kun je een subset van entiteiten in een collectie identificeren 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 history-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 gebruikersinterface.

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".

Title

String

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

Object compleetheid

integer

Geeft het percentage ingevulde vragenlijstvelden terug die gemarkeerd zijn als 'Gebruik in compleetheidsberekening'.

CreatedOn

String

De aanmaaktijd in ISO 8601 UTC-formaat

CreatedBy

String

De naam van de gebruiker die het object heeft aangemaakt

ChangedOn

String

De tijd van wijziging in ISO 8601 UTC-formaat.

Wordt niet ingevuld als een object alleen is aangemaakt.

ChangedBy

String

De naam van de gebruiker die de wijziging heeft doorgevoerd.

Wordt niet ingevuld als het object alleen is aangemaakt.

ArchivedOn

String

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

ArchivedBy

String

Wordt 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.

Definitie

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. Een willekeurige code wordt toegewezen bij het aanmaken, maar 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 gebruikersinterface.

Object_Properties_Name

String

Als de eigenschap begint met "Object_Properties", betreft het informatie uit "Objecteigenschappen" en niet uit de "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 gebruikersinterface

BlueDolphinObjectWorkspaceName

String

De naam van het bedrijfsonderdeel 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 het bedrijfsonderdeel 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 gebruikersinterface

Naam

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

Beschrijving

String

Geeft een lege string terug in een response

CreatedBy

String

De naam van de gebruiker die de relatie heeft aangemaakt

CreatedOn

String

De aanmaaktijd in ISO 8601 UTC-formaat

ChangedBy

String

De naam van de gebruiker die de wijziging heeft doorgevoerd

ChangedOn

String

De tijd van 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 het bedrijfsonderdeel

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 die op deze werkset staan

Eigenschap

Type

Beschrijving

NodeKey

String

Unieke identificatie voor het object op de werkset

ViewId

String

ID van de Werkset (kan koppelen aan de Werksets dataset)

ObjectId

String

ID van het Object (kan koppelen aan de Objecten dataset)

ObjectTypeId

String

ID van het type van het object

Titel

String

Objecttitel

Eigenschap

Type

Beschrijving

Id

String

Geschiedenis-id

TargetId

String

Id van het object

ChangedBy

String

De naam van de gebruiker

Acties

String

Geeft aan welke actie is uitgevoerd. Mogelijke waarden zijn:

Categorie

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 zoals getoond 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

Title

String

Titel van het item

Description

String

Beschrijving van het item

Status

Enum (String)

Status opgeslagen in het Engels

CreatedOn

Date

Aanmaakdatum

ChangedOn

Date

Datum van de laatste wijziging

StartDate

Date

Startdatum van het item

EndDate

Date

Einddatum van het item

DeliverableCount

Number

Aantal werkresultaten

PhaseCount

Number

Aantal fases

CollaboratorsCount

Number

Aantal samenwerkers

Eigenschap

Type

Beschrijving

Id

ObjectId

Unieke identificatie voor het werkresultaat (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 het werkresultaat

DeliverableStatus

String

Staat momenteel altijd op "Unknown"

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 is toegewezen aan het werkresultaat

AssigneeFirstName

String

Voornaam van de gebruiker die is toegewezen aan het werkresultaat

AssigneeLastName

String

Achternaam van de gebruiker die is toegewezen aan het werkresultaat

IsFlagged

Boolean

Geeft aan of het werkresultaat als Vlag is gemarkeerd

Deadline

Date

Datum van de deadline die op een werkresultaat 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 (legacy/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.

Description

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

Name

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 deze 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.
Dit kan gebruikt worden om te koppelen aan “Gebruikers”

RoleId

String

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