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

Pulling an object

Pulling an object

Use the pull resource to retrieve objects from your repository and load them into your organization.

POST request

To load the latest version of objects from your repository to your organization, use the following URI:
/public/core/v3/pull
You might receive a response to the POST request before the pull operation completes.
You can include the following fields in the request:
Field
Type
Required
Description
commitHash
String
Yes
Unique commit hash.
The commit hash is validated during the operation.
If you use a GitHub repository, you can include a partial hash in the request.
objects
List<Object>
Yes
Contains a list of all the objects to be pulled.
path
List<String>
Yes, if ID not included
Include in the objects object.
Full path of the object to be pulled.
id
String
Yes, if path not included
Include in the objects object.
ID of the asset.
type
String
-
Include in the objects object.
Type of asset to be pulled. If not specified, default is project.
Can be one of the following types:
  • DTEMPLATE. Mapping.
  • MTT. Mapping task.
  • DSS. Synchronization task.
  • DMASK. Masking task.
  • DRS. Replication task.
  • MAPPLET.
  • BSERVICE. Business service definition.
  • HSCHEMA. Hierarchical schema.
  • PCS. PowerCenter task.
  • FWCONFIG. Fixed width configuration.
  • CUSTOMSOURCE. Saved query.
  • MI_TASK. Mass ingestion task.
  • WORKFLOW. Linear taskflow.
  • VISIOTEMPLATE
  • TASKFLOW
objectSpecification
List<Object>
-
Object specification for connection and runtime environments.
source
Object
Yes, if objectSpecification object is included
Include in the objectSpecification object.
Contains information about the source object.
path
List<string>
Yes, if objectSpecification object is included
Include in the source object.
Path of the connection or runtime environment in the repository.
type
String
Yes, if objectSpecification object is included
Include in the source object.
Asset type.
target
Object
Yes, if objectSpecification object is included
Include in the objectSpecification object.
Contains information about the target object.
Include path and type or include ID. If path, type, and ID are included, ID takes precedence.
path
List<string>
Yes, if id is not included. Use with type.
Include in the target object.
Path of the connection or runtime environment in the repository.
Use with type.
type
String
Yes, if id is not included. Use with path.
Include in the target object.
Asset type.
Use with path.
id
String
Yes, if path and type are not included
Include in the target object.
ID of the target object.

POST response

If successful, a POST request returns the following information:
Field
Type
Description
pullActionId
String
ID for the pull operation.
Status
Object
Status of the pull operation.
state
String
Returned in the Status object.
Status of the pull operation.
Includes one of the following values:
  • In Progress
  • Success
  • Failed
message
String
Returned in the Status object
Descriptive status message for the pull operation.

POST example

To request a pull operation for two projects, you might send a request that's similar to the following example:
POST <baseApiUrl>/public/core/v3/pull Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId> { "commitHash": "7c525831c247cf792f595d1663396d1ae2c85033", "objects": [ { "path": ["Project2"] }, { "path": ["Default"] } ] }
The response might look like the following example:
{ "pullActionId": "iW5TmGqUjmUcdZKk4c4VQH", "status": { "state": "NOT_STARTED", "message": "Initialized" } }


Updated May 03, 2021