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

undoCheckout

undoCheckout

Use the undoCheckout resource to undo a checkout and revert the object to its original state.
You can undo the checkout of an asset, project, or folder. You can also undo a checkout for all objects that were included in a checkout. If you are logged in as an administrator, you can undo a checkout performed by another user.

POST request

To undo a checkout, use the following URI:
/public/core/v3/undoCheckout
In the request, include the ID or the path and type for each object that you want to perform the undo checkout operation. Or, include a checkout operation ID to undo the checkout for all objects that were included in a checkout action.
Source control logs are retained for seven days. If the checkout occurred more than seven days ago, the checkout operation ID no longer exists so it can't be used in an undo checkout operation.
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.
You can include the following fields in the request:
Field
Type
Required
Description
checkoutOperationId
String
-
Checkout operation ID. If specified, all assets that were included in the checkout operation will revert to their original state.
objects
List<Object>
-
Contains a list of all the objects to be included in the undo checkout operation.
id
String
Yes, if the object's path and type are not included and checkoutOperation ID is not included
Include in the objects object.
ID of the object.
path
List<String>
Yes, if the object's ID is not included and checkoutOperation ID is not included
Include in the objects object.
Full path of the object.
type
String
Yes, if the object's ID is not included and checkoutOperation ID is not included
Include in the objects object.
Type of asset.
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
includeContainerAssets
Boolean
-
Include in the objects object.
Applicable to projects and folders.
Whether all objects in a project or folder are included in the undo checkout operation. Use one of the following values:
  • true. Include all objects in the project or folder.
  • false. Do not include objects in the project or folder.
Default is false.
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.
Full 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. 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.
Path 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.

POST response

If successful, a POST request returns the following information:
Field
Type
Description
id
String
ID for the undo checkout operation.
status
Object
Status of the undo checkout operation.
state
String
Returned in the status object.
Initial state of the undo checkout operation. For a successful request, value will always be NOT_STARTED.
To see the status after the operation begins, use the sourceControlAction resource.
message
String
Returned in the status object.
Descriptive status message for the undo checkout operation.

POST request examples

To request an undoCheckout operation using asset IDs, you might send a request that's similar to the following example:
POST <baseApiUrl>/public/core/v3/undoCheckout Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId> { "objects": [ { "id": "4gmWUVziA1qe7zXbyN1l6E" }, { "id": "4TjbmrAGrk2eal3DOwdIk8" } ] }
To request an undo checkout operation for assets by path, you might send a request that's similar to the following example:
POST <baseApiUrl>/public/core/v3/undoCheckout Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId> { "objects": [ { "path": ["Default","Test_Mapping1"], "type": "DTEMPLATE" }, { "path": ["Default","Test_Mapping2"], "type": "DTEMPLATE" } ] }
To request an undoCheckout operation for an asset and map the source connection and runtime environment to the target connection and runtime environment, you might send a request that's similar to the following example:
POST <baseApiUrl>/public/core/v3/undoCheckout Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId> { "objects": [ { "id": "6wLjSK4tS4rdjKq5uGuC0T" } ], "objectSpecification":[ { "source": { "path":["ff"], "type":"Connection" }, "target": { "path":["target_connection"], "type":"Connection" } }, { "source": { "path": ["USW1MJ02YNFB"], "type": "AgentGroup" }, "target": { "id": "2ga6h3hRNZCf9Br0ZWB7EF" } } ] }
To request an undoCheckout operation using the checkout operation ID, you might send a request that's similar to the following example:
POST <baseApiUrl>/public/core/v3/undoCheckout Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId> { "checkoutOperationId": "<checkout operation ID>" }

POST response example

For any of the request examples, you might receive a response similar to the following example:
{ "id": "awRrziMMWXol7i42aTm1ih", "status": { "state": "NOT_STARTED", "message": "Initialized" } }

0 COMMENTS

We’d like to hear from you!