Enterprise Data Catalog REST API Reference > Object APIs > Object Modification APIs
  

Object Modification APIs

You can use the following Object Modification REST APIs to update the custom properties of an object:
Model Modification REST API
Description
PUT data/objects
Updates the custom properties for multiple objects
PUT data/objects/{id}
Updates the custom properties for an object

Data Objects Modification

objects
API to update the custom properties of multiple objects.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/data/objects
HTTP Method Type
PUT

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
objects
Required
The data objects for which you want to update the custom properties.
Body
Model
If-Match
Optional
Enter a value to display the results that match the value. Do not update if the entity tag or Etag for the resource has changed.
Header
String

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
Values
businessTerms
Optional
Associated business terms
Array [String]
Enter the following parameters:
  • - id. The ID of the associated business term.
  • - readOnly. Enter true if the object reference cannot be modified and cannot be included in requests to the server.
facts
Required
List of facts that apply to this object.
Array [String]
Enter the following parameters:
  • - attributeId. Enter the attribute ID.
  • - projectedFrom. Enter the ID of the object from which the fact is projected.
  • - readOnly. Enter true if the fact cannot be modified and cannot be included in requests to the server.
  • - value. Enter the fact value. This parameter is ignored if you provide the projectedFrom parameter.
id
Required
The ID of the object resource.
String
Enter the resource ID.
srcLinks
Optional
An upstream of objects.
Array [String]
Enter the following parameters:
  • - association. Enter the association ID.
  • - id. Enter the ID of the resource object.
  • - linkProperties. Enter the attribute ID and link property value.
  • - readOnly. Enter true if the link cannot be modified and cannot be included in requests to the server

Response Codes

Code
Reason
201
Created.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
412
Conflicting edit detected.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X PUT --header "Accept: application/json" -d "28037" "http://<CatalogAdmin>:<port>/access/2/catalog/data/objects"

Data Object Modification IDs

objects/{id}
API to update custom object properties of an object.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}
HTTP Method Type
PUT

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the object.
Path
String
objects
Required
The data object for which you want to update the custom properties.
Body
Model
If-Match
Optional
Enter a value to display the results that match the value. Do not update if the entity tag or Etag for the resource has changed.
Header
String

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
Values
businessTerms
Optional
Associated business terms.
Array [String]
Enter the following parameters:
  • - id. The ID of the associated business term.
  • - readOnly. Enter true if the object reference cannot be modified and cannot be included in requests to the server.
facts
Required
List of facts that apply to this object.
Array [String]
Enter the following parameters:
  • - attributeId. Enter the attribute ID.
  • - projectedFrom. Enter the ID of the object from which the fact is projected.
  • - readOnly. Enter true if the fact cannot be modified and cannot be included in requests to the server.
  • - value. Enter the fact value. This parameter is ignored if you provide the projectedFrom parameter.
id
Required
The ID of the object resource.
String
Enter the resource ID.
srcLinks
Optional
An upstream of objects.
Array [String]
Enter the following parameters:
  • - association. Enter the association ID.
  • - id. Enter the ID of the resource object.
  • - linkProperties. Enter the attribute ID and link property value.
  • - readOnly. Enter true if the link cannot be modified and cannot be included in requests to the server

Response Codes

Code
Reason
201
Created.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
412
Conflicting edit detected.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X PUT --header "Accept: application/json" -d "cust" "http://<CatalogAdmin>:<port>/access/2/catalog/data/objects/100"