Asset Developer Documentation

Lifecycle Stage and Status

The Lifecycle Stage and Status API is part of the ALM Tenant-Specific Configurations.

The business functional hierarchy, (Enterprise, Site, Segment, and Assets), includes the lifecycle stage and status reserved attributes, while tags include only the status reserved attribute.

The lifecycle stage and status API is used to enable reading, updating, editing, and deleting the default list of values provided for tenant-specific configuration.

You can change the default list items that appear in the drop-down lists in the user interface, add new list items, and delete list items. Additionally, you can enable or disable the user interface for the list items.

Read Supported Configuration Values

You can use API to read values of the ALM tenant configurations. The API provides tenant-specific reserved attribute information and the status of other ALM configurations. In addition, you can use filters to read specific information from the tenant configurations.

Each configuration has the following associated properties:

Add Supported Configurations

Update Supported Configurations

As a user, you can use the API to update the values of the ALM configurable reserved attributes. The changes made using APIs are applicable to the entire tenant.

All tenant-specified elements are editable, but a code that is already in use cannot be changed.

Delete Supported Configurations

As a tenant, you can use the API to delete tenant-specific ALM configuration based on the context and code. The deleted ALM tenant configurations will be removed from the entire tenant.

Enable or Disable the User Interface Edit Option

You can use the APIs to enable or disable the tenant configurable reserved attribute drop-downs to prohibit changes on the user interface. The changes made using APIs are applicable to the entire tenant.

To enable or disable the state and status, use UI flag configuration contexts.

Export Tenant Data

You can export classification JSON files for any business functional object (Enterprise, Site, Segment, or Asset) or Tag classifications to one or more zip files using the Asset APIs. A zip file can hold thousand classifications, which is a configurable value. Each export logs a task in the persistent store for tracking the export status. Once the export is completed, the blob url is provided to the user as part of the task response.

You can use the Asset APIs to export tenant classifications. You can use the UUID from the export request JSON response to check the status of the export task.

The downloaded zip files can be directly ingested to another tenant using the existing upload mechanism.

Classification Rules

Create a Classification Type

You are ready to add instances for the classifications.

Add Instances to a Classification

Create a Tag Classification Type

You are ready to add tag associations. For more information, refer to the About Instances documentation.

List Classifications

You can retrieve a list of classifications by criteria or URI using the APIs.

You can use the API to retrieve a list of classifications, classification types, inherited classification types, and parent classification types.

Use the API request parameters to narrow the list by criteria (e.g., sourceKey).

Delete a Classification

Instance Rules

Create an Instance

You are ready to add the instance to the business functional hierarchy.

Add an Instance to the Business Functional Hierarchy

You can add an enterprise, site, segment, or asset instance to the business functional hierarchy. Tag instances are added to an existing instance.

You can move an existing site, segment, or asset instance to another site, segment, or asset instance in the business functional hierarchy. Use your Asset Model to determine placement of the instance. You can add or move an instance to a node that is higher in the business functional hierarchy.

Move an Instance within the Business Functional Hierarchy

You can move an instance from one area in the business functional hierarchy to another.

You can move entails using PATCH or ingestion to update and replace the classification for an instance.

Based on the following scenarios, an instance is moved within the business functional hierarchy as follows:

1. If the custom attribute of the new classification has same name but different datatype than that of an instance attribute, an error message appears. In this case, you must either delete the instance attribute or delete the classification attribute to resolve the conflict.
2. If the custom attribute of the new classification has same name and same datatype of an instance attribute, the attribute that matches the new classification will be inherited to the instance from the new classification. However, the instance attribute values will not be updated even if the classification has the same attribute as that of the instance.
3. If the new classification contains attributes that are not available in the instance, the classification attributes are inherited to the instance along with their default values.

Remove an Instance from the Business Functional Hierarchy

You can remove instances from a business functional object.

Add Tags to an Instance

Remove Tags from an Instance

Search for Instances and Tags

You can retrieve a list of instances by criteria or URI using the APIs.

You can use the API to retrieve the instances associated to a business functional object.

/v3/tags/query?q=x=y
/v3/tags?sourceKeys=xyz,abc
v3/assets/uuid/tags?sourceKey=xyz&name=abc
v3/assets/uuid/tags/download?q=x=y

Delete an Instance

Cascade Delete of Instances

You must use precautionary measures when using the API to delete an asset or tag instance. The delete functionality permanently removes all child-assets, group associations, and the actual instance.

Upon successful deletion, the Audit Logs page updates the following information: Timestamp, UserName, Name, Resource, Resource Type, Action, Reason, and Detail. For example, Deleted Asset Instance-1234 (ID212434).

The API deletes the tag instance association and the tag instance.

Upon deletion the following HTTP status codes provide information that help with troubleshooting:

Asset Group Rules

Create an Asset Group

You are ready to add the asset members.

Add Members to an Asset Group

You can add members to an asset group in the JSON. All members of a group must be the same type.

You are ready to add asset groups to the business functional hierarchy.

Remove Members from an Asset Group

Add Asset Groups to the Business Functional Hierarchy

You can add asset groups to a business functional object using a parent node in the JSON.

Use your Asset Model to determine placement of the asset group. For example, you can add a group of asset instances to a segment, site, or asset instance node that is higher in the business functional hierarchy. Similarly, a group of sites instances can only be added to an enterprise node.

You can add a group to multiple parent nodes, or add multiple groups to a single parent node in the business functional hierarchy.

Remove Asset Groups from the Business Functional Hierarchy

You can remove asset groups from a business functional object.

List Asset Groups

You can retrieve a list of groups by criteria or URI using the APIs.

You can use the API to retrieve the groups associated to a business function object. Use the API with the group URI.

Use the API request parameters to narrow the list by criteria (e.g., sourceKey).

Delete Asset Groups