REST API Reference

Back Next

Checking in objects

Use the checkin resource to check updated objects in to the repository.

POST request

To check objects in to the repository, use the following URI:

/public/core/v3/checkin

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 in. You can check in a single asset or check in any number of projects or folders.
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 in.
type	String	Yes, if ID is not included	Include in the objects object. Type of asset to be checked in. 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.
summary	String	Yes	Summary of the check-in. Maximum length is 255 characters.
description	String	-	Description of the check-in.

POST response

If successful, a POST request returns the following information:

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

POST request examples for projects

You can request a check-in operation for one or more projects in a single POST request. To request a check-in 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/checkin
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

{
  "objects": [
    {
      "id": "3iWWHkLbM2giVppBmJmZgV",
      "includeContainerAssets": true
    }
  ],
  "summary": "Revised mappings",
  "description": "Revised m_custArch and m_custNew"
}

To request a check-in operation for an asset using the path and object type, you might send a request that's similar to the following example:

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

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

POST request examples for assets

You can request a check-in operation for one asset in a POST request. To request a check-in 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/checkin
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

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

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

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

{
  "objects": [
    {
      "id": "3iWWHkLbM2giVppBmJmZgV"
    }
  ],
  "summary": "Revised Revised m_custArch"
}

POST response example

A POST response might look like 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 in objects

Checking in objects

POST request

POST response

POST request examples for projects

POST request examples for assets

POST response example