Informatica Enterprise Data Catalog REST API Reference

Transcription

1 Informatica Enterprise Data Catalog REST API Reference

2 Informatica Enterprise Data Catalog REST API Reference May 2018 Copyright Informatica LLC 2017, 2018 This software and documentation are provided only under a separate license agreement containing restrictions on use and disclosure. No part of this document may be reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica LLC. Informatica and the Informatica logo are trademarks or registered trademarks of Informatica LLC in the United States and many jurisdictions throughout the world. A current list of Informatica trademarks is available on the web at Other company and product names may be trade names or trademarks of their respective owners. Portions of this software and/or documentation are subject to copyright held by third parties. Required third party notices are included with the product. U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation is subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR , Commercial Computer Software License. The information in this documentation is subject to change without notice. If you find any problems in this documentation, report them to us at infa_documentation@informatica.com. Informatica products are warranted according to the terms and conditions of the agreements under which they are provided. INFORMATICA PROVIDES THE INFORMATION IN THIS DOCUMENT "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OR CONDITION OF NON-INFRINGEMENT. Publication Date:

3 Table of Contents Preface... 5 Informatica Resources Informatica Network Informatica Knowledge Base Informatica Documentation Informatica Product Availability Matrixes Informatica Velocity Informatica Marketplace Informatica Global Customer Support Chapter 1: Overview... 7 Enterprise Data Catalog REST API Overview Prerequisites Accessing the APIs Chapter 2: Model REST APIs... 9 Model REST APIs Overview Model Information APIs Association Kinds Association Kind Details Attribute Details Class Details Data Type Details List Association Kinds List Associations List Attributes List Classes List Data Types List Reference Attributes List Reference Data Types Reference Attribute Details Reference Data Type Details Model Modification APIs Create Custom Reference Attribute Create Custom Attributes Delete Custom Attribute Delete Custom Reference Attribute Update Custom Attribute Update Custom Reference Attribute Table of Contents 3

4 Chapter 3: Object APIs Object REST APIs Overview Object Information APIs Data Objects Data Object IDs Relationships Object Modification APIs Data Objects Modification Data Object Modification IDs Chapter 4: Resource REST APIs Resource REST APIs Overview Resource Execution API Load Resource Job Resource Info API Monitor a Resource Job Chapter 5: Use Cases Sample Use Cases Retrieve Attribute Details Retrieve Attribute Details for a Class Retrieve Objects Using Object Name Retrieve Object Details Using Object ID Retrieve Relationships Between Objects Update Custom Attribute Update a Custom Attribute and Custom Reference Attribute for an Object Create Custom Attribute Create Reference Attribute Load Resource Job Monitor a Resource Job Table of Contents

5 Preface The Informatica Enterprise Data Catalog REST API Reference is written for developers who want to customise Enterprise Data Catalog by using the concepts exposed by the REST APIs. It is assumed that you have a good understanding of REST concepts and experience using REST APIs. Informatica Resources Informatica Network Informatica Network hosts Informatica Global Customer Support, the Informatica Knowledge Base, and other product resources. To access Informatica Network, visit As a member, you can: Access all of your Informatica resources in one place. Search the Knowledge Base for product resources, including documentation, FAQs, and best practices. View product availability information. Review your support cases. Find your local Informatica User Group Network and collaborate with your peers. Informatica Knowledge Base Use the Informatica Knowledge Base to search Informatica Network for product resources such as documentation, how-to articles, best practices, and PAMs. To access the Knowledge Base, visit If you have questions, comments, or ideas about the Knowledge Base, contact the Informatica Knowledge Base team at KB_Feedback@informatica.com. Informatica Documentation To get the latest documentation for your product, browse the Informatica Knowledge Base at If you have questions, comments, or ideas about this documentation, contact the Informatica Documentation team through at infa_documentation@informatica.com. 5

6 Informatica Product Availability Matrixes Product Availability Matrixes (PAMs) indicate the versions of operating systems, databases, and other types of data sources and targets that a product release supports. If you are an Informatica Network member, you can access PAMs at Informatica Velocity Informatica Velocity is a collection of tips and best practices developed by Informatica Professional Services. Developed from the real-world experience of hundreds of data management projects, Informatica Velocity represents the collective knowledge of our consultants who have worked with organizations from around the world to plan, develop, deploy, and maintain successful data management solutions. If you are an Informatica Network member, you can access Informatica Velocity resources at If you have questions, comments, or ideas about Informatica Velocity, contact Informatica Professional Services at ips@informatica.com. Informatica Marketplace The Informatica Marketplace is a forum where you can find solutions that augment, extend, or enhance your Informatica implementations. By leveraging any of the hundreds of solutions from Informatica developers and partners, you can improve your productivity and speed up time to implementation on your projects. You can access Informatica Marketplace at Informatica Global Customer Support You can contact a Global Support Center by telephone or through Online Support on Informatica Network. To find your local Informatica Global Customer Support telephone number, visit the Informatica website at the following link: If you are an Informatica Network member, you can use Online Support at 6 Preface

7 C h a p t e r 1 Overview This chapter includes the following topics: Enterprise Data Catalog REST API Overview, 7 Prerequisites, 8 Accessing the APIs, 8 Enterprise Data Catalog REST API Overview Representational State Transfer (REST) Web Services provide interoperability between computers that communicate through internet. You can use a REST Web Service to interact with Web resources and perform updates on Web resources. A REST Web Service conforms to the principles of REST by being client-server oriented and stateless and uses the HTTP protocol and methods for communication. APIs that conform to the REST principles are known as REST APIs. You can use REST APIs to extract, create, modify or delete information in the system through REST Web Services. The REST APIs are created using Swagger specification. You can use the Enterprise Data Catalog REST APIs to extract information from models and objects and update models and objects. The APIs expose the following concepts: Model Data A model defines the structure for the metadata that the scanner ingests in the catalog. Data represents the metadata ingested in the catalog. Concepts Exposed by the Model Attributes A model property that you can set on an object as a fact. Association A model link that you can create between two objects. Association Kinds Types of associations. Data Types Types of attributes. 7

8 Classes Types of objects. Reference Attributes Type of attribute that projects a value from a source object to a target object. Concepts Exposed by Data Object Fact Links An object is an asset in the catalog. The object includes facts and you can link an object to other objects. Scanners or users create facts and links. An instantiated attribute of an object. For example, Created by and Modified by are facts. An instantiated association between two objects. Prerequisites Verify that you perform the following prerequisites before you use the REST APIs: Install Enterprise Data Catalog. Identify and install the HTTP client that you want to use to call the REST APIs. Accessing the APIs You can use the following URL to view the list of REST APIs exposed: <catalogadminurl>:<port>/access/ swagger-ui.html#/ <catalogadminurl> represents the URL of the machine where you installed Catalog Administrator. <port> represents the port number configured for the Catalog Service. You can use the following URL format to call the REST APIs: <Type of HTTP method> <eumadminurl>:<port>/access/2/catalog/models/<rest API>. The models directory includes all the REST APIs exposed for retrieving and updating information related to models. You can replace the models directory with data directory to call the REST APIs exposed to retrieve information about objects. For example, to call the REST API GET 2/catalog/models/associationKinds, use the following URL: GET You can use any standard HTTP client or use the Java client provided with Enterprise Data Catalog to call the REST APIs. You can download the Java client and the source files with the Javadocs from the following locations: Java client. <catalogadminurl>:<port>/access/2/files/client.jar Source files and Javadocs. <catalogadminurl>:<port>/access/2/files/client-sources.jar 8 Chapter 1: Overview

9 C h a p t e r 2 Model REST APIs This chapter includes the following topics: Model REST APIs Overview, 9 Model Information APIs, 10 Model Modification APIs, 23 Model REST APIs Overview To access and update the Enterprise Unified Metadata REST Web Services, you can use the Model REST APIs that are classified into the following categories: Model Information APIs Model Modification APIs You can use the Model Information APIs to perform the following operations to extract information associated with the model: List types of associations. List association type details. List associations. List association details. List attributes. List attribute details. List classes. List class details. List data types. List data type details. List reference attributes. List reference attribute details. List reference data types. List reference data type details. You can use the Model Modification APIs to perform the following operations to create, delete, or update information associated with the model: Create custom attributes. 9

10 Delete custom attributes. Update custom attributes. Create custom reference attributes. Delete custom reference attributes. Update custom reference attributes. Model Information APIs You can use the following Model Information REST APIs to extract information from the model: Model Information REST API GET associationkinds GET associationkinds/{id GET associations GET associations/{id GET attributes GET attributes/{id GET classes GET classes/{id GET datatypes GET datatypes/{id GET referenceattributes GET referenceattributes/{id GET referencedatatypes GET referencedatatypes{id Description List association types. List association type details. List associations. List association details. List attributes. List attribute details. List classes. List class details. List data types. List data type details. List reference attributes. List reference attribute details. List reference data types. List reference data type details. 10 Chapter 2: Model REST APIs

11 Association Kinds associations/{id API to list details of an association. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/associations/{id GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Required The ID of the association. Path Response Codes Code 200 Listed association types successfully. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. Association Kind Details associationkinds/{id API to list association type details. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/associationkinds/{id GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Optional The ID of the association. Path Model Information APIs 11

12 Response Codes Code 200 Listed association type details successfully. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. Attribute Details attributes/{id API to list details of an attribute. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/attributes/{id GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Required The ID of the attribute. Path Response Codes Code 200 Listed attribute details successfully. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. 12 Chapter 2: Model REST APIs

13 Class Details classes/{id API to list class details. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/classes/{id GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Required The ID of the class. Path Response Codes Code 200 Listed class details successfully. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. Data Type Details datatypes{id API to list types of association. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/datatypes{id GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Required The ID of the data type. Path Model Information APIs 13

14 Response Codes Code 200 Listed association types successfully. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. List Association Kinds associationkinds API to list types of association. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/associationkinds?offset=0&pagesize=20 GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Optional The ID of the association. If you want to provide multiple IDs, verify that you provide each ID on another line. offset Optional The offset position from which the association types must start for listing. Default is 0. pagesize Optional The number of results to be displayed on a page. Default is 20. Query Query Query Array[string] Integer Integer 14 Chapter 2: Model REST APIs

15 Response Codes Code 200 Listed association types successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. List Associations associations API to list associations. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/associations?offset=0&pagesize=20 GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Optional The ID of the association. If you want to provide multiple IDs, verify that you provide each ID on another line. offset Optional The offset position from which the association types must start for listing. Default is 0. Query Query Array[string] Integer Model Information APIs 15

16 Parameter Required or Optional Description Parameter Type Data Type pagesize Optional The number of results to be displayed on a page. Default is 20. isa Optional Displays associations that inherit the specified association types. Query Query Integer Array[string] Response Codes Code 200 Listed association types successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. List Attributes attributes API to list attributes. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/attributes?offset=0&pagesize=20 GET 16 Chapter 2: Model REST APIs

17 URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Optional The ID of the attribute. If you want to provide multiple IDs, verify that you provide each ID on another line. classid Optional ID of the class that you want to use to filter the attributes. If you want to provide multiple IDs, verify that you provide each ID on another line. offset Optional The offset position from which the attributes must start for listing. Default is 0. pagesize Optional The number of results to be displayed on a page. Default is 20. Query Query Query Query Array[string] Array[string] Integer Integer Response Codes Code 200 Listed attributes successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. Model Information APIs 17

18 List Classes classes API to list classes in a model. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/classes?offset=0&pagesize=20 GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Optional The ID of the class. If you want to provide multiple IDs, verify that you provide each ID on another line. offset Optional The offset position from which the association types must start for listing. Default is 0. pagesize Optional The number of results to be displayed on a page. Default is 20. isa Optional Displays classes that inherit the specified class types. Query Query Query Query Array[string] Integer Integer Array[string] Response Codes Code 200 Listed association types successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions, 18 Chapter 2: Model REST APIs

19 Code 404 Requested object not found. 429 Rate limit for requests encountered. List Data Types datatypes API to list types of data. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/datatypes?offset=0&pagesize=20 GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Optional The ID of the data type. If you want to provide multiple IDs, verify that you provide each ID on another line. offset Optional The offset position from which the data types must start for listing. Default is 0. pagesize Optional The number of results to be displayed on a page. Default is 20. Query Query Query Array[string] Integer Integer Response Codes Code 200 Listed association types successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions, Model Information APIs 19

20 Code 404 Requested object not found. 429 Rate limit for requests encountered. List Reference Attributes referenceattributes API to list reference attributes. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/referenceattributes?offset=0&pagesize=20 GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Optional The ID of the reference attribute. If you want to provide multiple IDs, verify that you provide each ID on another line. classid Optional The ID of the class based on which you want to filter the reference attributes. offset Optional The offset position from which the reference attributes must start for listing. Default is 0. pagesize Optional The number of results to be displayed on a page. Default is 20. Query Query Query Query Array[string] Array[string] Integer Integer 20 Chapter 2: Model REST APIs

21 Response Codes Code 200 Listed reference attributes successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. List Reference Data Types referencedatatypes API to list reference data types. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/referencedatatypes?offset=0&pagesize=20 GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Optional The ID of the reference data type. If you want to provide multiple IDs, verify that you provide each ID on another line. offset Optional The offset position from which the reference data types must start for listing. Default is 0. pagesize Optional The number of results to be displayed on a page. Default is 20. Query Query Query Array[string] Integer Integer Model Information APIs 21

22 Response Codes Code 200 Listed reference data types successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. Reference Attribute Details referenceattributes{id API to list details of a reference attribute. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/modelsreferenceattributes{id GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Required The ID of the reference attribute. Path Response Codes Code 200 Listed association types successfully. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. 22 Chapter 2: Model REST APIs

23 Reference Data Type Details referencedatatypes{id API to list details of a reference data type. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/referencedatatypes{id GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Required The ID of the reference data type. Path Response Codes Code 200 Listed reference data type details successfully. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. Model Modification APIs You can use the following Model Modification REST APIs to create, delete, or update information in the model: Model Modification REST API POST attributes DELETE attributes/{id PUT attributes/{id POST referenceattributes Description Create custom attributes. Delete custom attributes. Update custom attributes. Create custom reference attributes. Model Modification APIs 23

24 Model Modification REST API DELETE referenceattributes/{id PUT referenceattributes/{id Description Delete custom reference attributes. Update custom reference attributes. Create Custom Reference Attribute referenceattributes API to create a custom reference attribute. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/referenceattributes POST URL Parameters Parameter Required or Optional Description Parameter Type Data Type attribute Required Details of the custom reference attribute. Body Model Attribute Parameters Parameter Required or Optional Description Data Type Values analyzer Optional Classification for the custom reference attribute type. boost Optional Search ranking priority for the custom reference attribute. Provide one of the following values: - INT - LONG - FLOAT - DOUBLE - BOOLEAN - DATE - STRING - TEXT_GENERAL - PATH_HIERARC HY Provide one of the following values: - LOWEST - LOWER - LOW - MEDIUM - HIGH 24 Chapter 2: Model REST APIs

25 Parameter Required or Optional Description Data Type Values classes Optional List of classes that might have the custom reference attribute. Array Provide the list of classes in the following format: classes": [ { "id": "string", ] datatypeid Required ID of the model resource. description Optional Description for the custom reference attribute. facetable Optional Specifies if the custom reference attribute must appear on the list of filters in Enterprise Data Catalog. Default is true. multivalued Optional Specifies if the custom reference attribute must appear on the list of filters in Enterprise Data Catalog. Default is true. name Required Name of the custom reference attribute. searchable Optional Specifies if you can use the custom reference attribute to perform searches in Enterprise Data Catalog. Default is true. sortable Optional Specifies if you can sort the search results using the custom reference attribute in Enterprise Data Catalog. Default is true. Boolean Boolean Boolean Boolean User to provide the ID. User to provide the description. Provide one of the following values: - true - false Provide one of the following values: - true - false User to provide the name. Provide one of the following values: - true - false Provide one of the following values: - true - false Model Modification APIs 25

26 Parameter Required or Optional Description Data Type Values suggestable Optional Specifies if the custom reference attribute must appear in the list of automatic suggestions in Enterprise Data Catalog. Default is true. Boolean Provide one of the following values: - true - false id ID of the model resource. User to provide the ID. Response Codes Code 201 Custom reference attribute created successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. Create Custom Attributes attributes API to update a custom attribute. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/attributes POST URL Parameters Parameter Required or Optional Description Parameter Type Data Type attribute Required Details of the custom attribute. Body Model 26 Chapter 2: Model REST APIs

27 Attribute Parameters Parameter Required or Optional Description Data Type Values analyzer Optional Classification for the custom attribute type. boost Optional Search ranking priority for the custom attribute. classes Optional List of classes that might have the custom attribute. Array Provide one of the following values: - INT - LONG - FLOAT - DOUBLE - BOOLEAN - DATE - STRING - TEXT_GENERAL - PATH_HIERARC HY Provide one of the following values: - LOWEST - LOWER - LOW - MEDIUM - HIGH Provide the list of classes in the following format: classes": [ { "id": "string", ] datatypeid Required ID of the model resource. description Optional Description for the custom attribute. facetable Optional Specifies if the custom attribute must appear on the list of filters in Enterprise Data Catalog. Default is true. multivalued Optional Specifies if the custom attribute must appear on the list of filters in Enterprise Data Catalog. Default is true. name Required Name of the custom attribute. Boolean Boolean User to provide the ID. User to provide the description. Provide one of the following values: - true - false Provide one of the following values: - true - false User to provide the name. Model Modification APIs 27

28 Parameter Required or Optional Description Data Type Values searchable Optional Specifies if you can use the custom attribute to perform searches in Enterprise Data Catalog. Default is true. sortable Optional Specifies if you can sort the search results using the custom attribute in Enterprise Data Catalog. Default is true. suggestable Optional Specifies if the custom attribute must appear in the list of automatic suggestions in Enterprise Data Catalog. Default is true. Boolean Boolean Boolean Provide one of the following values: - true - false Provide one of the following values: - true - false Provide one of the following values: - true - false id ID of the model resource. User to provide the ID. Response Codes Code 201 Custom attribute created successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. 28 Chapter 2: Model REST APIs

29 Delete Custom Attribute attributes/{id API to delete a custom attribute. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/attributes/{id DELETE URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Required ID of custom attribute. Path Response Codes Code 200 Custom attribute deleted successfully. 204 No content. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. Delete Custom Reference Attribute referenceattributes/{id API to delete a custom reference attribute. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/referenceattributes/{id DELETE Model Modification APIs 29

30 URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Required ID of custom reference attribute. Path Response Codes Code 200 Custom attribute deleted successfully. 204 No content. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 429 Rate limit for requests encountered. Update Custom Attribute attributes/{id API to update a custom attribute. Note: You must index the catalog after you use the API. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/attributes/{id PUT 30 Chapter 2: Model REST APIs

31 URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Required ID of custom attribute. attribute Required Details that you want to update for the custom attribute. if-match Optional Identify the ETag for the resource. Enterprise Unified Metadata does not update the resource if the ETag for the resource has changed. Path Body Header Model Attribute Parameters Parameter Required or Optional Description Data Type Values analyzer Optional Classification for the custom attribute type. boost Optional Search ranking priority for the custom attribute. classes Optional List of classes that might have the custom attribute. Array Provide one of the following values: - INT - LONG - FLOAT - DOUBLE - BOOLEAN - DATE - STRING - TEXT_GENERAL - PATH_HIERARC HY Provide one of the following values: - LOWEST - LOWER - LOW - MEDIUM - HIGH Provide the list of classes in the following format: classes": [ { "id": "string", ] Model Modification APIs 31

32 Parameter Required or Optional Description Data Type Values id Required ID of the model resource. description Optional Description for the custom attribute. facetable Optional Specifies if the custom attribute must appear on the list of filters in Enterprise Data Catalog. Default is true. name Required Name of the custom attribute. Boolean User to provide the ID. User to provide the description. Provide one of the following values: - true - false User to provide the name. Response Codes Code 201 Custom attribute updated successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 412 Conflicting update detected. 429 Rate limit for requests encountered. Update Custom Reference Attribute referenceattributes/{id API to update a custom reference attribute. Note: You must index the catalog after you use the API. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/models/referenceattributes/{id PUT 32 Chapter 2: Model REST APIs

33 URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Required ID of custom reference attribute. attribute Required Details that you want to updated for the custom reference attribute. if-match Optional Identify the ETag for the resource. Enterprise Unified Metadata does not update the resource if the ETag for the resource has changed. Path Body Header Model Attribute Parameters Parameter Required or Optional Description Data Type Values analyzer Optional Classification for the custom reference attribute type. boost Optional Search ranking priority for the custom reference attribute. classes Optional List of classes that might have the custom reference attribute. Array Provide one of the following values: - INT - LONG - FLOAT - DOUBLE - BOOLEAN - DATE - STRING - TEXT_GENERAL - PATH_HIERARC HY Provide one of the following values: - LOWEST - LOWER - LOW - MEDIUM - HIGH Provide the list of classes in the following format: classes": [ { "id": "string", ] Model Modification APIs 33

34 Parameter Required or Optional Description Data Type Values id Required ID of the model resource. description Optional Description for the custom reference attribute. facetable Optional Specifies if the custom reference attribute must appear on the list of filters in Enterprise Data Catalog. Default is true. name Required Name of the custom reference attribute. Boolean User to provide the ID. User to provide the description. Provide one of the following values: - true - false User to provide the name. Response Codes Code 201 Custom reference attribute updated successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions, 404 Requested object not found. 412 Conflicting update detected. 429 Rate limit for requests encountered. 34 Chapter 2: Model REST APIs

35 C h a p t e r 3 Object APIs This chapter includes the following topics: Object REST APIs Overview, 35 Object Information APIs, 35 Object Modification APIs, 40 Object REST APIs Overview To access, view, and update the data objects in Enterprise Data Catalog, you can use the Enterprise Unified Metadata REST APIs, such as Object Information APIs and Object Modification APIs. You can use the Object Information APIs to list the objects, view the details of the objects, and view the relationships between the objects in the catalog. You can use the Object Modification APIs to update the custom properties for one or multiple objects in the catalog. Object Information APIs You can use the following Object Information REST APIs for the objects in the catalog: Model Information REST API GET objects GET objects/{id GET relationships Description List the objects. List the object details. List the relationships between the objects. 35

36 Data Objects objects The endpoint return the objects in the catalog. An endpoint is an object that has a connection to another object in a different resource. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/data/objects GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type q Required Use to create a query that searches matching objects. Uses Apache Lucene to interpret the query. id Optional The ID of the data object. You can use multiple values to query the catalog. Enter each value in a new line. offset Optional The starting point in the results. The results after the offset value is displayed. By default, the offset value is 0. query query query string Arrary[string] integer 36 Chapter 3: Object APIs

37 Parameter Required or Optional Description Parameter Type Data Type pagesize Optional The number of results to display in a page. By default, you can view 20 results per page. related Optional Returns the related objects if you set the parameter to true and configure the q parameter. If q parameter is not configured, no results are generated. By default, related parameter is set to false. query query integer boolean Response Codes Code 200 Returns objects and object details successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions. 404 Requested object not found. 429 Rate limit for requests encountered. Sample Call Using Curl curl -X GET --header "Accept: application/json" " data/objects?q=*" Data Object IDs objects/{id API returns the details about an object. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/data/objects/{id GET Object Information APIs 37

38 URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Required The ID of the data object. path string Response Codes Code 200 Returns the object and object details successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions. 404 Requested object not found. 429 Rate limit for requests encountered. Sample Call Using Curl curl -X GET --header "Accept: application/json" " data/objects/ " Relationships relationships The endpoint returns the relationship between an object and other objects in Enterprise Data Catalog. An endpoint is an object that has a connection to another object in a different resource. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/data/relationships GET 38 Chapter 3: Object APIs

39 URL Parameters Parameter Required or Optional Description Parameter Type Data Type seed Required The ID of the data asset. You can enter multiple IDs. Enter each ID in a new line. association Required The association ID or association kind ID. Lineage or association displays where the data for an asset comes from and the assets that impact it. You can enter the association ID or association kind ID. depth Required The depth of traversal which is the number of return links in the lineage. Enter 0 or N as the depth of traversal, where N is an integer. Enter 0 to display complete lineage. Enter a number N to display the lineage for N hops from the seed node. direction Optional Direction to traverse for lineage. Enter BOTH, IN, or OUT. By default, BOTH is the configured direction. query query query query Arrary[string] Arrary[string] integer string removeduplicatea ggregatelinks Optional When set to true, the duplicate aggregate links do not appear in the response. By default, this parameter is set to true. Sometimes, the scanners create duplicate aggregate links. query boolean Object Information APIs 39

40 Parameter Required or Optional Description Parameter Type Data Type includeterms Optional When set to true, the connected business terms are embedded in the response. By default, this parameter is set to false. includeattribute Optional The attribute ID. The fact related to the attribute ID is embedded in the response. Enter each ID in a new line. query query boolean Array[string] Response Codes Code 200 Listed association types successfully. 400 Missing or invalid parameter. 401 Missing credentials. 403 User does not have the required access permissions. 404 Requested object not found. 429 Rate limit for requests encountered. Sample Call Using Curl curl -X GET --header "Accept: application/json" " data/relationships? seed=<seedvalue>&association=<associationvalue>&depth=<depthvalue>&direction=<direction>& removeduplicateaggregatelinks=<true/false>&includeterms=<true/false>" Object Modification APIs You can use the following Object Modification REST APIs to update the custom properties of an object: Model Modification REST API PUT attributes PUT attributes/{id Description Update the custom properties for multiple objects. Update the custom properties for an object. 40 Chapter 3: Object APIs

41 Data Objects Modification objects API to update the custom properties of multiple objects. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/data/objects PUT URL Parameters Parameter Required or Optional Description Parameter Type Data Type objects Required The data objects for which you want to update the custom properties. 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. body header model string Object Modification APIs 41

42 Attribute Parameters Parameter Required or Optional Description Data Type Values businessterms Optional Associated business terms. Array[string] Provide a list of business terms for the data object in the following format: ObjectRefReque st { id (string): Id of object resource facts Optional List of facts that apply to this object. Array[string] Provide a list of attribute IDs and values for the facts in the following format: FactRequest { attributeid (string): Attribute id, value (string, optional): Fact value id Required The ID of the object resource. string Enter the resource ID. 42 Chapter 3: Object APIs

43 Parameter Required or Optional Description Data Type Values srclinks Optional An upstream of objects. Array[string] Provide a list of association IDs, object resource IDs, attribute IDs, and property value for source links in the following format: LinkedObjectRe quest { association (string): Association id, id (string): Id of object resource, linkproperties (Array[LinkPro pertyrequest], optional) LinkPropertyRe quest { attributeid (string): Attribute id, value (string, optional): Property value attributeid Required The ID of the attribute. string Provide the attribute ID. value Optional The fact value. string Provide the fact value. association Required The ID of the association. string Provide the association ID. Object Modification APIs 43

44 Parameter Required or Optional Description Data Type Values linkproperties Optional The request includes attribute ID and property value. Array[string] Provide a request for link properties in the following format: LinkPropertyRe quest { attributeid (string): Attribute id, value (string, optional): Property value value Optional The property value. string Provide a property value. Response Codes Code 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 "Content-Type: application/json" --header "Accept: application/ json" -d "28037" " Data Object Modification IDs objects/{id API to update custom object properties of an object. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/data/objects/{id PUT 44 Chapter 3: Object APIs

45 URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Required The ID of the object. objects Required The data object for which you want to update the custom properties. 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. path body header string model string Attribute Parameters Parameter Required or Optional Description Data Type Values businessterms Optional Associated business terms. Array[string] Provide a list of business terms in the following format: ObjectRefReque st { id (string): Id of object resource facts Optional List of facts that apply to this object. Array[string] Provide a list of attribute IDs and values for the facts in the following format: FactRequest { attributeid (string): Attribute id, value (string, optional): Fact value id Required The ID of the object resource. string Provide the resource ID. Object Modification APIs 45

46 Parameter Required or Optional Description Data Type Values srclinks Optional An upstream of objects. Array[string] Provide a list of association IDs, object resource IDs, attribute IDs, and property value for the source links in the following format: LinkedObjectRe quest { association (string): Association id, id (string): Id of object resource, linkproperties (Array[LinkPro pertyrequest], optional) LinkPropertyRe quest { attributeid (string): Attribute id, value (string, optional): Property value attributeid Required The ID of the attribute. string Provide the attribute ID. value Optional The fact value. string Provide the fact value. association Required The ID of the association. string Provide the association ID. 46 Chapter 3: Object APIs

47 Parameter Required or Optional Description Data Type Values linkproperties Optional The request includes attribute ID and property value. Array[string] Provide a request for link properties in the following format: LinkPropertyRe quest { attributeid (string): Attribute id, value (string, optional): Property value value Optional The property value. string Provide the property value. Response Codes Code 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 "Content-Type: application/json" --header "Accept: application/ json" -d "cust" " Object Modification APIs 47

48 C h a p t e r 4 Resource REST APIs This chapter includes the following topics: Resource REST APIs Overview, 48 Resource Execution API, 48 Resource Info API, 49 Resource REST APIs Overview To manually load a resource and monitor a resource job in Enterprise Data Catalog, you can use Enterprise Unified Metadata REST APIs, such as Resource Execution API and Resource Info API. Resource Execution API You can use the POST loads Resource Execution REST API to manually load the specified resource. Load Resource Job loads API to trigger resource run for the specified resource. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/resources/jobs/loads POST URL Parameters Parameter Required or Optional Description Parameter Type Data Type resourceexecution Request Required Resource name Body 48

49 Response Codes Code 200 Submitted the resource job to run. 201 Created a resource. 400 Missing or invalid resource name. 401 Missing login credentials. 403 User does not have the access permission to view or edit the resource. 404 Requested resource not found. 429 Rate limit for requests encountered. Resource Info API You can use the GET loads/{id Resource Info REST API to get the job status for the specified resource. Monitor a Resource Job loads/{id API to list the job status of the specified resource. REST API Element Request URL HTTP Method Type Input Format <eumadminurl>:<port>/access/2/catalog/resources/jobs/loads/{id GET URL Parameters Parameter Required or Optional Description Parameter Type Data Type id Required ID of the resource job Path Response Codes Code 200 List the details of the specified resource job. 400 Missing or invalid resource name. Resource Info API 49

50 Code 401 Missing login credentials. 403 User does not have the access permission to view or edit the resource. 404 Requested resource not found. 429 Rate limit for requests encountered. 50 Chapter 4: Resource REST APIs

51 C h a p t e r 5 Use Cases This chapter includes the following topics: Sample Use Cases, 51 Retrieve Attribute Details, 52 Retrieve Attribute Details for a Class, 53 Retrieve Objects Using Object Name, 53 Retrieve Object Details Using Object ID, 54 Retrieve Relationships Between Objects, 54 Update Custom Attribute, 55 Update a Custom Attribute and Custom Reference Attribute for an Object, 56 Create Custom Attribute, 57 Create Reference Attribute, 58 Load Resource Job, 59 Monitor a Resource Job, 59 Sample Use Cases The sample use cases provide scenarios to show you how you can use the REST APIs to retrieve or update information. The samples include Java code samples that you can use with the bundled Java client and the Curl call samples for the REST APIs. The following are the list of sample use cases for the REST APIs: Retrieve the last modified details of an attribute. Retrieve the attribute details of a class. Retrieve objects using object name. Retrieve object details using object ID. Retrieve relationships for columns. Create a custom attribute with specific properties to search for locations based on a ZIP code. Update a custom attribute and custom reference attribute for an object. Update a custom attribute. Create a custom reference attribute that updates a change to the attribute across all the fields where the attribute is associated. 51