Add External Attribute
By using this operation, you can create user-defined external attributes at run time when golden record cache is defined and running.
Important: You must specify the attribute name according to ActiveSpaces recommendation and it must not exist in the repository space definition.
HTTP Method | ||||
Endpoint URL | See Endpoint | |||
Resource | /fastcache/metadata/addFields | |||
Body Parameters | Specify the following parameters: | |||
Name | Description | Data Type | ||
string | ||||
repositoryName | Repository name on which the operation is to be performed. | string | ||
FieldsToBeAdded | A map which contains the key or key-value as an external attribute name and value as its data type | Map of string | ||
name | Attribute Name | string | ||
dataType | Data type of an attribute | |||
Media Type | body | |||
Request Model |
{ "repositoryName": "string", "cacheIndexList": [ { "indexName": "string", "indexType": "string", "indexColumnNames": [ "string" ] } ], "fieldsToBeAdded": [ { "name": "string", "displayName": "string", "dataType": "string" } ] } |
|||
Response Model |
{ responseMessages: [ { "code": "string", "message": "string", "type": "string", ] "success": "boolean" } ] } ] |
|||
Request Example |
{ "repositoryName": ”CUSTOMER”, "fieldsToBeAdded": [ { "name": "LOYALITYPOINTS", "dataType": "LONG" }, { "name": "BONUS", "dataType": "INTEGER" } ] |
|||
Response Example |
{ "code": "FC-00008", "message": "Field/s added successfully", "type": "Info" } |
|||
Success Response | Example:
Code: 200 successful operation |
|||
Error Response | If the response is unsuccessful, either of the following error code is displayed:
Example: Code: 400 Parameters required are missing OR Code: 500 Invalid Request For error code response, see Error Handling . |
The following data types are supported while adding external attributes in the golden record cache repository. The API accepts only the MDM supported data types.
Generic Data Type Name | TIBCO MDM DataType | Corresponding ActiveSpaces Field Type |
---|---|---|
Boolean | BOOLEAN | BOOLEAN |
DECIMAL NUMBER | AMOUNT | DOUBLE
The double range is 2.2250738585072014E-308 to 1.7976931348623157e+308 so in case data is outside of the range, then data may lost. |
DECIMAL | ||
CUSTOM DECIMAL | ||
Integer | INTEGER | INTEGER |
Long | LONG | LONG |
Date | DATE | DATETIME |
TIMESTAMP | TIMESTAMP | DATETIME |
String | STRING | STRING |
Url | URL | STRING |
Copyright © Cloud Software Group, Inc. All rights reserved.