Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. Mass Ingestion Files REST API
  7. Mass Ingestion Streaming REST API
  8. RunAJob utility
  9. ParamSetCli utility
  10. REST API codes
  11. REST API resource quick references

REST API Reference

REST API Reference

REST API responses

REST API responses

A successful REST API response returns the requested object, an array of objects, or an HTTP success code. A failed response returns an HTTP error code and can also return an error object.

Successul responses

The following table describes common successful responses to REST API requests:
Request type
Response
GET
For an information request, returns the requested object or an array of objects when applicable.
For an action request, returns the HTTP 200 success code. Can also return the REST API success object.
POST
Returns the object that you created or updated.
Can also return the HTTP 201 success code.
DELETE
HTTP 200 success code.
Can also return the REST API success object.
For example, if you use a GET request to view a schedule, a successful response is the schedule object that you requested. Or, if you use a POST request to update the time that the schedule runs, a successful response is the schedule object that you updated, including the update. If you use a DELETE request to delete a schedule that is no longer being used, a successful response is the 200 success code.

Failed responses

For a failed response, the REST API returns a standard HTTP error code and can also return an error object. The following table describes some of the HTTP error codes that might be returned:
HTTP error code
Description
400
Bad request. Can be a field or format issue such as an invalid character or incorrect string length.
401
Authentication issue. For example, invalid credentials or invalid session IDs.
403
Generic error. For example, user doesn't have required permissions for a resource.
404
Resource can't be found.
500
Unexpected error. Generic error message that appears when an unexpected condition was encountered.
502
Network issue.
503
Service unavailable. The server cannot handle the request.

0 COMMENTS

We’d like to hear from you!