Attributes

The Attributes API V5 allows you to manage custom attributes in Netcore CE. You can use these APIs to create, search, update, delete, and check the usage of attributes.

Attribute API operations

Important Points to Remember

• Create and Delete are asynchronous operations.
• A successful response confirms that the request was accepted; it does not confirm that processing has completed.
• Search and Usage return the result directly in the response.
• Before updating or deleting an attribute, check where the attribute is being used.

Prerequisites

Ensure the following before you start:

• You have a valid Netcore API key.
• Use Content-Type: application/json.
• Use the regional base URL applicable to your account.
• Ensure the attribute name, category, and data type are valid.
• Ensure the attribute is compatible with any mapping configured for it.

Authentication

All Attribute API requests require the api-key header.

POST {{BASE_URL}}/client/attribute/create
api-key: YOUR_API_KEY
Content-Type: application/json

Important: Replace YOUR_API_KEY with your actual API key.

Base URLs by Region

Attribute API overview

Create attributes

Use the Create Attributes API to add one or more custom attributes to Netcore CE.

You can define properties such as:

• Attribute name
• Attribute category
• Data type
• Default value
• Attribute mapping
• Data masking

The API processes the creation request asynchronously.

Search attributes

Use the Search Attributes API to find attributes based on criteria such as attribute name, entity type, or data type.

The API supports:

• Filtering
• Partial attribute-name search
• Sorting
• Pagination
• Returning the total count

The Search Attributes API is synchronous, so the matching attributes are returned directly in the response.

Update attributes

Use the Update Attributes API to modify supported properties of an existing attribute, such as its name, data type, default value, mapping, or data masking configuration.

Some attribute properties have restrictions once they are configured or mapped.

Delete attributes

Use the Delete Attributes API to remove an attribute.

The delete operation is asynchronous. A successful response confirms that the request was accepted for processing; it does not confirm that the attribute has already been deleted.

Check attribute usage

Use the Attribute Usage API to check where an attribute is being used before making changes or deleting it.

This helps identify dependencies on the attribute across Netcore features.

Typical Attribute lifecycle

A typical workflow is:

Create → Search → Use → Check Usage → Update/Delete

Before deleting or making a significant change to an attribute, use the Usage API to identify existing dependencies.

Response handling

For asynchronous operations such as Create and Delete, a 200 response means that the request was accepted for processing. It does not indicate that the operation has completed.

For synchronous operations such as Search and Usage, the response contains the result of the request.

Troubleshoot and FAQs

Q. Can I create multiple attributes in one request?

Yes. The Create Attributes API accepts a data array containing the attributes to be created.

Q. Can I search for attributes by name?

Yes. The Search Attributes API supports attribute-name filtering and partial name search.

Q. Can I change an attribute after it has been mapped?

Mapping restrictions apply after an attribute has been mapped. Check the attribute's current usage and mapping before attempting an update.

Q. Does a successful Create or Delete response mean the operation is complete?

No. Create and Delete are asynchronous. A successful response means that the request was accepted for processing.

Q. How can I check whether an attribute is being used?

Use the Attribute Usage API before updating or deleting the attribute.