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. RunAJob utility
  8. REST API codes
  9. REST API resource quick references

REST API Reference

REST API Reference

Getting pull status

Getting pull status

Use the pull resource to get the status of a pull operation.

GET request

Include the pull action ID in the request URI. The pull action ID is returned in the response when you send a pull request.
To receive status of a pull operation, use the following URI:
public/core/v3/pull/<pullActionId>
To receive status for each object included in a pull operation, use the following URI:
public/core/v3/pull/<pullActionId>?expand=objects

GET response

The response includes the following information:
Field
Type
Description
pullActionId
String
ID of the pull operation.
startTime
TimeStamp
Start time of the pull operation.
endTime
TimeStamp
End time of the pull operation.
Status
Object
Includes pull status information for the pull operation.
state
String
Status of the pull operation. Included in the Status object.
Returns on the following values:
  • In Progress
  • Success
  • Failed
message
String
Descriptive status message for the pull operation. Included in the Status object.
objects
Object
Lists each object included in the pull operation.
Returned when expand=objects is specified in the URI.
target
Object
Target object.
Included in the objects object.
id
String
ID of the target object.
Included in the target object.
path
List<string>
Complete path of the target object. For example, "Default" , "mt_MappingTask1".
Included in the target object.
type
String
Asset type of the target object.
Included in the target object.
status
Object
Includes pull status information for each object in the pull operation.
state
String
Pull status for the object. Included in the status object.
Returns on the following values:
  • In Progress
  • Success
  • Failed
message
String
Detailed pull status message for the object.

Pull status examples

To get pull status for a pull operation, you might send a request that's similar to the following example:
POST <baseApiUrl>/public/core/v3/pull/drLV4N8PFiuhAbcprrur2W Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId>
The response might look like the following example:
{ "pullActionId":"drLV4N8PFiuhAbcprrur2W", "startTime": "2020-03-24T22:07:44Z", "endTime": "2020-03-24T22:08:14Z", "status": { "state": "SUCCESSFUL", "message": "Pull Successful" }, "objects":null }
To get pull status for a pull operation that includes status information for each object in the pull, you might send a request that's similar to the following example:
POST <baseApiUrl>/public/core/v3/pull/drLV4N8PFiuhAbcprrur2W?expand=objects Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId>
The response might look like the following example:
{ "pullActionId":"drLV4N8PFiuhAbcprrur2W", "startTime": "2020-03-24T22:07:44Z", "endTime": "2020-03-24T22:08:14Z", "status": { "state": "SUCCESSFUL", "message": "Pull Successful" }, "objects": [ { "target": { "path": [ "Versioned_Project", "Versioned_Folder", "Versioned Mapping - Rename" ], "id": "2CefbUuBsYxhG6eeKXvGmh", "type": "MAPPING" }, "status": { "state": "SUCCESSFUL", "message": "Overwrite existing object" } }, { "target": { "path": [ "Versioned_Project", "Versioned_Folder" ], "id": "jHM0CWxwTkuivWNBE7y22l", "type": "Folder" }, "status": { "state": "SUCCESSFUL", "message": "Reuse existing object" } }, { "target": { "path": null, "id": "gSkynhxE4wWjZlRQ163fE0", "type": "MAPPING" }, "status": { "state": "WARNING", "message": "Delete object." } } ] }


Updated May 03, 2021