REST API Reference

Back Next

Pulling objects in a commit

Use the pullByCommitHash resource to retrieve objects that were modified by a particular commit and load them into your organization.

When you use the pullByCommitHash resource, you include a commit hash in the request. The objects that changed in the commit are included in the pull. If you want to pull objects by path or object ID, use the pull resource instead.

If you use project-level repositories, include the repoConnectionId field in a pullByCommitHash request. You can find the repoConnectionId for projects by sending a repositoryConnection request. For more information about finding the repoConnectionId, see Getting repository connection details.

If you want an asset to use a different connection or runtime environment, you can map the connection or runtime environment to a connection or runtime environment in your organization using the objectSpecification object.

Informatica recommends that you include less than 1000 objects in a pull request.

POST request

To load the objects that changed in a particular commit from your repository to your organization, use the following URI:

/public/core/v3/pullByCommitHash

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 by sending the first 7 characters of the commit hash. For other repositories, include the full 40-character commit hash.
searchCustomRepositories	Boolean	No	Whether to search project-level repositories if the commit hash wasn't found for the global repository.
repoConnectionId	String	No	Connection ID of the project-level repository to search. If not specified, the global repository is searched.
relaxObjectSpecificationValidation	Boolean	No	Whether the sources specified in the objectSpecification object must exist in the assets being pulled. Use one of the following values: true. The objectSpecification objects are ignored if the sources don't exist in the assets that are included in the pull. false. An error occurs when an objectSpecification source doesn't exist in the assets that are included in the pull. Default is false.
objectSpecification	List<Object>	No	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. Name of the connection or runtime environment in the repository.
type	String	Yes, if objectSpecification object is included	Include in the source object. Asset type. Use one of the following values: Connection AgentGroup
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	Include in the target object. Name of the connection or runtime environment. Use with type.
type	String	Yes, if ID is not included	Include in the target object. Asset type. Use with path. Use one of the following values: Connection AgentGroup
id	String	Yes, if path and type are not included	Include in the target object. ID of the target object.
additionalProviderFlags	Collection <complex type>	No	Additional object specifications. Use key-value pairs to specify additional object specifications, such as in-out parameter values and sequence generator values.

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. Initial state of the pull operation. For a successful request, value will always be NOT_STARTED. To see the status after the operation begins, use the Getting the status of a source control operation resource.
message	String	Returned in the status object Descriptive status message for the pull operation.

POST request examples

To request a pull operation for all changed assets in a commit, you might send a request that's similar to the following example:

POST <baseApiUrl>/public/core/v3/pullByCommitHash
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

{
    "commitHash": "7c525831c247cf792f595d1663396d1ae2c85033"
}

To request a pull operation for all changed assets in a commit made to a project-level repository, you might send a request that's similar to the following example:

POST <baseApiUrl>/public/core/v3/pullByCommitHash
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

{
    "commitHash": "7c525831c247cf792f595d1663396d1ae2c85033",
    "searchCustomRepositories": true
}

To request a pull operation for all changed assets in a commit and include connections and runtime environments, you might send a request that's similar to the following example:

POST <baseApiUrl>/public/core/v3/pullByCommitHash
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

{
 
    "commitHash": "1013f61bf318758cccec08f2165f59bbbb41e8f0",
    "objectSpecification":[
     {
        "source":
        {
            "path":["ff"],
            "type":"Connection"
        },
        "target":
        {
            "path":["target_connection"],
            "type":"Connection"
        }
     },
     {
        "source": {
            "path": ["USW1MJ02YNFB"],
            "type": "AgentGroup"
        },
        "target": {
            "id": "2ga6h3hRNZCf9Br0ZWB7EF"
        }
     }
   ]
}

POST response example

For a successful POST request, the response might look like the following example:

{
    "pullActionId": "iW5TmGqUjmUcdZKk4c4VQH",
    "status": {
        "state": "NOT_STARTED",
        "message": "Initialized"
    }
}

Source control

Download Guide

Watch

Comments

Cloud Data Integration Homepage

0 COMMENTS

We’d like to hear from you! Log in to comment.

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Pulling objects in a commit

Pulling objects in a commit

POST request

POST response

POST request examples

POST response example