Data Integration Service REST API Overview
Use the Data Integration Service REST API to send REST API requests to the Data Integration Service. You can use the REST API to automate tasks in a CI/CD pipeline, such as version control operations, application deployment, application updates, and testing.
Some REST API requests accept a query as a request parameter. The objects that the query returns are the objects that the request operates on. For example, when you run a request to tag objects, you specify a query and the query determines the objects that are tagged. Similarly, you can specify a query to deploy a certain set of design-time objects to an application patch archive file.
To construct a query, you use query parameters to determine the objects that you want to retrieve. You can make a query more specific based on the types of query parameters, operators, and clauses that you use.
To view the REST API requests that you can use and the parameters for each request, access the REST API documentation through the Administrator tool. If you access the REST API documentation through the ROH service, you need to enable the reverse proxy server and configure the reverse proxy server properties. For more information, see
Reverse Proxy Server Properties.
The following table describes the different request categories that you can view when you access the REST API documentation:
Category | Description |
|---|
Objects | Requests to perform operations on design-time objects. |
Applications | Requests to perform operations on run-time objects in an application. |
Mapping Service | Requests to perform operations on deployed mappings. |
Utilities | Requests to run Data Integration Service utilities. Utilities provide extended capabilities to the Data Integration Service. For example, the Data Integration Service can compare two mappings and return a report that identifies differences. |