Develop > Application Programming Interface > Legacy APIs > Artifact API > Artifact views

Artifact Views

Artifact views provide a convenient way to perform retrieve or update actions. When views are used with artifact GET and fastview GET requests, the response includes only the relevant information depending on the type of view requested. When used with PUT requests, the body of the request can include just relevant information, compared to typical PUT requests.

Advantages of Views

  • With GET requests, views retrieve only the relevant data for the artifact and avoid loading all the data for the artifact. This leads to better performance.
  • With PUT requests, the burden is not on the user to know all the artifact details to update the artifact. The user can pass only the necessary information.
  • An example of using views is presented in Update an artifact (using componentfinalize view). 

Note: If you are updating with artifact views, you need to specify all the view’s properties. 

The following predefined views are available:

View name Properties Description
accesspoint accessPoint.username
accessPoint.password
accessPoint.uri
accessPoint.category.name 		This retrieves information from the access point object. Any entity that has the accessPoint property should work with this view.
actioninfo action.actionState.name
action.actionStatus
action.errorOnTimeout
action.failOnError 
action.timeout
action.processDefinition.name
action.consumerVisible
action.stateConstraint.lifecycleState.name
action.stateConstraint.lifecycleSubstate.name 		Retrieves the properties for the action object in addition to all the basicinfo and propertyinfo properties.
Note: If the intention is to update an existing action, then action.id must be specified.
artifactinfo state.name
artifactType.name
disabled
ownedBy.name 		Retrieves the required properties from an artifact object in addition to all the basicinfo properties.
basicinfo id
name
displayName
description
iconUrl
detailedDescription
isCriticalSystemObject 		Retrieves information from any Identity object. All artifacts and some additional entities (e.g., accessPoint) are identity objects.
candidatepools* resourceBinding.candidateProvider
.candidatePool.id
.candidatePool.objectId
.candidatePool.isCriticalSystemObject
.candidatePool.name
.candidatePool.displayName
.candidatePool.disabled
.candidatePool.useProviderEnv  		Use this view to retrieve candidate resource provider pools for a given resource binding.
candidateproviders* resourceBinding.candidateProvider
.resourceProvider.id
.resourceProvider.objectId
.resourceProvider.isCriticalSystemObject
.resourceProvider.name
.resourceProvider.displayName
.resourceProvider.disabled  		Use this view to retrieve candidate resource providers for a given resource binding.
componentchild componentChild.name
componentChild.displayName
componentChild.description
componentChild.iconUrl
componentChild.detailedDescription
componentChild.isCriticalSystemObject
componentChild.ownedBy.name
componentChild.state.name
componentChild.artifactType.name
componentChild.disabled
componentChild.serviceInstance.id
componentChild.componentType.name
componentChild.lifecycleProperties.lifecycleState.name
componentChild.lifecycleProperties.lifecycleSubstate.name
componentChild.id 		Use this view to add/update service components from the parent service component.
componentfinalize toFinalize Use this view to change the finalize flag for a component.
componentlifecycle lifecycleProperties.lifecycleState.name
lifecycleProperties.lifecycleSubstate.name 		Use this view to change the lifecycle state and substate for a component.
componentroot componentRoot.name
componentRoot.displayName
componentRoot.description
componentRoot.iconUrl
componentRoot.detailedDescription
componentRoot.isCriticalSystemObject
componentRoot.ownedBy.name
componentRoot.state.name
componentRoot.artifactType.name
componentRoot.disabled
componentRoot.serviceInstance.id
componentRoot.componentType.name
componentRoot.lifecycleProperties.lifecycleState.name   
componentRoot.lifecycleProperties.lifecycleSubstate.name
componentRoot.id 		Use this view to add a root service component to a ServiceBlueprint or a ServiceInstance object.
disabledesign ServiceBlueprint.disabled Use this view to enable or disable a ServiceBlueprint.
propertyinfo property.name
property.values.value
property.valueType.name
property.consumerVisible
property.displayName 		Retrieves a list of all the properties. Used for creating new properties.
propertyvalue property.name
property.values.value
property.consumerVisible
property.displayName 		This view is useful if the need is only to update a property value.
resourcebindinginfo resourceBinding.isCriticalSystemObject
resourceBinding.state.name
resourceBinding.artifactType.name
resourceBinding.disabled
resourceBinding.bindingState.name
resourceBinding.resourceOffering.name
resourceBinding.lifeCycleProperties.lifecycleState.name
resourceBinding.lifeCycleProperties.lifecycleSubstate.name
resourceBinding.resourceProvider.name 		Use this view to create/update a Resource Binding.
validproviders* resourceBinding.id
resourceBinding.validProvider.resourceBinding.id
resourceBinding.validProvider.resourceProvider.id 		Use this view to retrieve or to update valid resource providers for a given resource binding.
validproviderspools* resourceBinding.id
resourceBinding.validProvider.resourceBinding.id
resourceBinding.validProvider.resourceProvider.id
resourceBinding.validProvider.validPool.id 		Use this view to update valid resource providers and valid resource provider pools for a given resource binding.

* For the candidatepools, candidateproviders, validproviders and validproviderpools artifact views, while the provider selection is in progress the list of providers will be returned. Once a provider is selected no list will be returned.

Send Help Center feedback