REST API Reference

Back Next

Checking out objects

Use the checkout resource to check out a source-controlled object so that you can make changes to it. When you check out an object, the object is locked so that other users can't make changes to it.

You can check out multiple projects, folders, or assets in one request.

If multiple objects are included in the checkout and the checkout fails for any of them, none of the objects will be checked out. The objects that would have been successful will have a status of CANCELLED.

For more information about the checkout status, see Getting the status of a source control operation.

POST request

To check objects out of the repository, use the following URI:

/public/core/v3/checkout

In the request, you must provide either the object ID or the full path and object type.

You can include the following fields in the request:

Field	Type	Required	Description
objects	List<Object>	Yes	Contains a list of all the objects to be checked out.
id	String	Yes, if path and type are not included	Include in the objects object. ID of the object.
path	List<String>	Yes, if ID is not included	Include in the objects object. Full path of the object to be checked out.
type	String	Yes, if ID is not included	Include in the objects object. Type of asset to be checked out. 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 PROCESS. Application Integration process. AI_CONNECTION. Application Integration app connection. AI_SERVICE_CONNECTOR. Application Integration service connector. GUIDE. Application Integration guide. PROCESS_OBJECT. Application Integration process object. HUMAN_TASK. Application Integration human task.
includeContainerAssets	Boolean	-	Include in the objects object. Whether all objects in a project or folder are included in the check-in. 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.

POST response

If successful, a POST request returns the following information:

Field	Type	Description
Id	String	ID for the checkout operation.
status	Object	Status of the checkout operation.
state	String	Returned in the status object. Initial state of the checkout 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 checkout operation.

POST request examples

To request a checkout operation for a project and include all of the assets in the project, you might send a request that's similar to the following example:

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

{
  "objects": [
    {
      "id": "ejZY66c19YUccBdbGwKG4P",
      "includeContainerAssets": true
    }
  ]
}

To request a checkout operation for a project and include two of the assets in the project, you might send a request that's similar to the following example:

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

{
  "objects": [
    {
      "id": "iIVBNZSpUKFg4N6g2PKUox",
      "includeContainerAssets": false
    },
    {
      "id": "l7bgB85m5oGiXObDxwnvK9"
    },
    {
      "id": "1MW0GDAE1sFgnvWkvom7mK"
    }
  ]
}

To request a checkout operation for an asset named Test_Mapping that's in the Default project, you might send a request that's similar to the following example:

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

{
  "objects": [
    {
      "path": [
        "Default",
        "Test_Mapping"
      ],
      "type": "DTEMPLATE"
    }
  ]
}

To request a checkout operation using the asset ID, you might send a request that's similar to the following example:

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

{
  "objects": [
    {
      "id": "3iWWHkLbM2giVppBmJmZgV"
    }
  ]
}

POST response example

You might receive a response similar to the following example:

{
    "id": "awRrziMMWXol7i42aTm1ih",
    "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

Checking out objects

Checking out objects

POST request

POST response

POST request examples

POST response example