< Back
Get-BDObject
Post
NAME Get-BDObject
SYNOPSIS
gets Objects from BlueDolphin
SYNTAX
Get-BDObject [[-Contains] <Object>] [-IsExactly <Hashtable>] [-Select <Array>] [-Top <Int32>] [-Skip <Int32>]
[-AllRecords] [-anyCondition] [<CommonParameters>]
Get-BDObject -CustomFilter <ValidateNotNullOrEmptyAttribute> [-Select <Array>] [-Top <Int32>] [-Skip <Int32>]
[-AllRecords] [-anyCondition] [<CommonParameters>]
DESCRIPTION
Returns Objects from the BlueDolphin site. Without filter it will return all Objects but filters can be set to
limit the number of objects returned.
PARAMETERS
-Contains <Object>
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IsExactly <Hashtable>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CustomFilter <ValidateNotNullOrEmptyAttribute>
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Select <Array>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Top <Int32>
Required? false
Position? named
Default value $_Settings.Defaults.Top
Accept pipeline input? false
Accept wildcard characters? false
-Skip <Int32>
Required? false
Position? named
Default value $_Settings.Defaults.Skip
Accept pipeline input? false
Accept wildcard characters? false
-AllRecords [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-anyCondition [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
-------------------------- <EXAMPLE 1>--------------------------
C:\\PS> get-bdobject
returns all objects
-------------------------- <EXAMPLE 2> --------------------------
C:\\PS> get-bdobject -filter "Definition eq 'Application Component'"
Returns all Applicationcomponent Objects in BlueDolphin
-------------------------- <EXAMPLE 3> --------------------------
C:\\PS> get-bdobject -filter "Definition eq 'Application Component' and Title ne 'App1'"
Returns all Application Component objects except App1
-------------------------- <EXAMPLE 4> --------------------------
C:\\PS> get-bdobject -filter "ArchimateType eq 'business_process'"
Returns all objects of archimatetype business_process
-------------------------- <EXAMPLE 5> --------------------------
C:\\PS> get-bdobject -filter "Definition eq 'Business Process' and contains(Title,'test')"
Returns all objects of Business Process with test in the title
RELATED LINKS
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Get-BDObjectDefinition; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Get-BDObjectDefinition [[-Contains] <Object>] [-IsExactly <hashtable>] [<CommonParameters>]
ModuleName : BlueDolphin
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Get-BDObjectDefinition
Category : Function
Component :
Role :
Functionality :
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Get-BDRelatedObject; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Get-BDRelatedObject [-Identity] <string> [-Select <array>] [-Top <int>] [-AnyCondition]
[<CommonParameters>]
Get-BDRelatedObject [-Title <string>] [-ID <string>] [-Select <array>] [-Top <int>]
[-AnyCondition] [<CommonParameters>]
ModuleName : BlueDolphin
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Get-BDRelatedObject
Category : Function
Component :
Role :
Functionality :
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Get-BDRelation; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Get-BDRelation [[-Contains] <Object>] [-IsExactly <hashtable>] [-Select <array>] [-Top
<int>] [-Skip <int>] [-AllRecords] [-AnyCondition] [<CommonParameters>]
Get-BDRelation -CustomFilter <ValidateNotNullOrEmpty> [-Select <array>] [-Top <int>] [-Skip
<int>] [-AllRecords] [-AnyCondition] [<CommonParameters>]
ModuleName : BlueDolphin
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Get-BDRelation
Category : Function
Component :
Role :
Functionality :
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Get-BDRelationDefinition; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Get-BDRelationDefinition [[-Contains] <Object>] [-IsExactly <hashtable>]
[<CommonParameters>]
ModuleName : BlueDolphin
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Get-BDRelationDefinition
Category : Function
Component :
Role :
Functionality :
SYNOPSIS
gets Objects from BlueDolphin
SYNTAX
Get-BDObject [[-Contains] <Object>] [-IsExactly <Hashtable>] [-Select <Array>] [-Top <Int32>] [-Skip <Int32>]
[-AllRecords] [-anyCondition] [<CommonParameters>]
Get-BDObject -CustomFilter <ValidateNotNullOrEmptyAttribute> [-Select <Array>] [-Top <Int32>] [-Skip <Int32>]
[-AllRecords] [-anyCondition] [<CommonParameters>]
DESCRIPTION
Returns Objects from the BlueDolphin site. Without filter it will return all Objects but filters can be set to
limit the number of objects returned.
PARAMETERS
-Contains <Object>
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IsExactly <Hashtable>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CustomFilter <ValidateNotNullOrEmptyAttribute>
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Select <Array>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Top <Int32>
Required? false
Position? named
Default value $_Settings.Defaults.Top
Accept pipeline input? false
Accept wildcard characters? false
-Skip <Int32>
Required? false
Position? named
Default value $_Settings.Defaults.Skip
Accept pipeline input? false
Accept wildcard characters? false
-AllRecords [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-anyCondition [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
-------------------------- <EXAMPLE 1>--------------------------
C:\\PS> get-bdobject
returns all objects
-------------------------- <EXAMPLE 2> --------------------------
C:\\PS> get-bdobject -filter "Definition eq 'Application Component'"
Returns all Applicationcomponent Objects in BlueDolphin
-------------------------- <EXAMPLE 3> --------------------------
C:\\PS> get-bdobject -filter "Definition eq 'Application Component' and Title ne 'App1'"
Returns all Application Component objects except App1
-------------------------- <EXAMPLE 4> --------------------------
C:\\PS> get-bdobject -filter "ArchimateType eq 'business_process'"
Returns all objects of archimatetype business_process
-------------------------- <EXAMPLE 5> --------------------------
C:\\PS> get-bdobject -filter "Definition eq 'Business Process' and contains(Title,'test')"
Returns all objects of Business Process with test in the title
RELATED LINKS
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Get-BDObjectDefinition; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Get-BDObjectDefinition [[-Contains] <Object>] [-IsExactly <hashtable>] [<CommonParameters>]
ModuleName : BlueDolphin
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Get-BDObjectDefinition
Category : Function
Component :
Role :
Functionality :
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Get-BDRelatedObject; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Get-BDRelatedObject [-Identity] <string> [-Select <array>] [-Top <int>] [-AnyCondition]
[<CommonParameters>]
Get-BDRelatedObject [-Title <string>] [-ID <string>] [-Select <array>] [-Top <int>]
[-AnyCondition] [<CommonParameters>]
ModuleName : BlueDolphin
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Get-BDRelatedObject
Category : Function
Component :
Role :
Functionality :
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Get-BDRelation; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Get-BDRelation [[-Contains] <Object>] [-IsExactly <hashtable>] [-Select <array>] [-Top
<int>] [-Skip <int>] [-AllRecords] [-AnyCondition] [<CommonParameters>]
Get-BDRelation -CustomFilter <ValidateNotNullOrEmpty> [-Select <array>] [-Top <int>] [-Skip
<int>] [-AllRecords] [-AnyCondition] [<CommonParameters>]
ModuleName : BlueDolphin
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Get-BDRelation
Category : Function
Component :
Role :
Functionality :
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Get-BDRelationDefinition; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Get-BDRelationDefinition [[-Contains] <Object>] [-IsExactly <hashtable>]
[<CommonParameters>]
ModuleName : BlueDolphin
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Get-BDRelationDefinition
Category : Function
Component :
Role :
Functionality :