REST API Reference

Back Next

Finding an asset

Use the objects resource to find assets in an organization using query parameters.

Query parameters include filters for asset type, tag, folder location, last update time, the user who last updated the asset, and source control metadata. Query parameters also include the maximum number of assets to return and the number of elements to skip.

The response can include up to 200 assets. If a request uses query parameters that result in more than 200 assets, you can send an additional request using the skip parameter to skip the assets that you received in the previous response.

The response does not include assets that you do not have privileges to read.

GET request

To request a list of assets, use the following URI:

/public/core/v3/objects?<query parameters>

You can use the following query parameters in the URI:

Parameter	Type	Description
q	String	Query filter.
limit	Int	Maximum number of assets to return, up to 200.
skip	Int	Number of elements to skip. For example, a value of 4 excludes the first four assets in the list.

You can use the following fields to define the query filter:

Field	Type	Operators	Description
type	String	== !=	Asset type. Type can be project, folder, or one of the following asset types: For Data Integration , the object can be one of the following types: DTEMPLATE. Mapping. MTT. Mapping task. DSS. Synchronization task. DMASK. Masking task. DRS. Replication task. DMAPPLET. Mapplet created in Data Integration . MAPPLET. PowerCenter 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. TASKFLOW PROJECT FOLDER For Application Integration , the object can be one of the following types: PROCESS GUIDE AI_CONNECTION AI_SERVICE_CONNECTOR PROCESS_OBJECT For B2B Gateway, the object can be one of the following types: B2BGW_MONITOR B2BGW_CUSTOMER B2BGW_SUPPLIER For MDM SaaS , the object can be one of the following types: MDM_BUSINESS_ENTITY MDM_REFERENCE_ENTITY MDM_HIERARCHY MDM_RELATIONSHIP MDM_JOB_DEFINITION MDM_AUTHORIZATION MDM_BUSINESS_EVENT MDM_REPORT_SET MDM_REPORT MDM_DYNAMIC_POOL MDM_APPLICATION MDM_SRC_SYSTEM MDM_APP_COMPONENT MDM_APP_PAGE For Data Quality , the object can be one of the following types: CLEANSE DEDUPLICATE DICTIONARY EXCEPTION LABELER PARSE RULE_SPECIFICATION VERIFIER Object types are not case sensitive.
location	String	==	The project and folder path where the assets are located, such as Default/Sales.
updateTime	Date	< <= == => > !=	The last time the assets were updated.
updatedBy	String	== !=	The user who last updated the assets. Use the userName value for the user.
tag	String	==	The tag associated with the assets.
sourceControl.checkedOutBy	String	==, !=	User who checked out the asset.
sourceControl.checkedOutTime	Date	<,<=,==,=>,>, !=	Time the asset was checked out.
sourceControl.hash	String	==, !=	Source control hash. Supports partial hash using a wildcard ( * ).
sourceControl.lastCheckinBy	String	==, !=	User who last checked in the asset.
sourceControl.lastCheckinTime	Date	<,<=,==,=>,>, !=	The last time the asset was checked in.
sourceControl.lastPullTime	Date	<,<=,==,=>,>, !=	The last time the asset was pulled.
sourceControl.sourceControlled	Boolean	==, !=	Whether the asset is source controlled.
customAttributes.publishedBy	String	==, !=	User who published the asset. Applicable to Application Integration .
customAttributes.publicationDate	Date	<,<=,==,=>,>, !=	Date the asset was published. Applicable to Application Integration .

GET request examples

The following examples show how you can use query parameters to request a list of assets:

To request a list of

Data Integration

mapping

tasks that were last updated November 21, 2018 or later, you might use the following URI:

/public/core/v3/objects?q=type=='MTT' and updateTime>=2018-11-21T12:00:00Z

To request a list of

Data Integration

mapping

tasks that were last updated November 21, 2018 or later, you might use the following URI:

/public/core/v3/objects?q=type=='MTT' and updateTime>=2018-11-21T12:00:00Z

To request a list of assets located in the Default/SalesOpps folder that were last updated before March 27, 2018, you might use the following URI:

/public/core/v3/objects?q=location=='Default/SalesOpps' and updateTime<2018-03-27T12:00:00Z

To request a list of assets associated with the UpsellOpps tag that were last updated January 10, 2018 or later, you might use the following URI:

/public/core/v3/objects?q=tag=='UpsellOpps' and updateTime>=2018-01-10T12:00:00Z

To request a list of up to 150 assets that were last updated December 30, 2017, excluding

Data Integration

mappings, you might use the following URI:

/public/core/v3/objects?q=type!='MAPPING' and updateTime=2017-12-30T12:00:00Z&max=150

To request a list of assets over the limit of 200, you might use the following URI in an additional request:

/public/core/v3/objects?limit=200&skip=200

GET response

If successful, returns a list of assets and a count of the assets based on the query results. If errors occur, returns an error object.

If the result size is large, for example, over 1000 objects, the count returned in the response might not be precise for up to 90 seconds. The fetch list returns all the results using the top and limit parameters included in the request, even though the returned count in the API might not have changed. Also, the count field might not be the first field in the response.

A successful response includes the following information:

Field	Type	Description
count	String	Number of assets matching the filter query.
objects	-	Contains information for each of the assets.
id	String	Global unique identifier for the asset. Use the value of this field as the value for taskFederatedId when you submit a job request.
path	String	Full path of the asset including project, folder, and object name.
type	String	Type of asset.
description	String	Description of the asset.
updatedBy	String	User name of the user who last updated the asset. If the asset is a system-created object such as the Default project and the Add-On Bundles folder, the value for this field is Informatica .
updateTime	String	Last time the asset was modified.
tag	String	Tags associated with the asset.
sourceControl	-	Contains source control metadata for the asset.
sourceControl.checkedOutBy	String	User who checked out the object.
sourceControl.checkedOutTime	Date	Time the asset was checked out.
sourceControl.hash	String	Source control hash for the asset.
sourceControl.lastCheckinBy	String	User who checked out the object.
sourceControl.lastCheckinTime	Date	Time that the asset was checked in last.
sourceControl.lastPullTime	Date	Time that the asset was pulled last.
sourceControl.sourceControlled	Boolean	Whether the asset is source controlled.
customAttributes	-	Contains publishing metadata for the Application Integration asset.
customAttributes.publishedBy	String	Included in the customAttributes object. User who published the asset. Applicable to Application Integration .
customAttributes.publicationDate	Date	Included in the customAttributes object. Date that the asset was published. Applicable to Application Integration .

GET example

The following example shows a request to receive a list of assets that are in the P1 folder and limit the response to two assets:

GET /saas/public/core/v3/objects?q=location=='P1'&limit=2 
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: 3H05q5PicfolyDXnp3N06c

The response includes information for the first two assets as shown in the following example:

{
    "count": 4,
    "objects": [
        {
            "id": "1a3TnUrT2cfiwQGtkWQEUy",
            "path": "P1/F1",
            "type": "Folder",
            "description": "",
            "updatedBy": "mma@infa.com",
            "updateTime": "2018-12-17T00:29:29Z"
            "tags": [
                "tag3",
                "tag4"
             ],
            "sourceControl": {
                "checkedOutBy": "mma@infa.com",
                "checkedOutTime": "2020-05-05T17:37:13Z",
                "hash": "3e082fb9bcb2349e9f0a4fb516c739610c869391",
                "lastCheckinTime": "2020-05-05T04:51:09Z",
                "lastCheckinBy": "mma@infa.com",
                "lastPullTime": null,
                "sourceControlled": true
            },
            "customAttributes": {
                "publishedBy": "mma@infa.com"
            }
        },
        {
            "id": "0dGB1jBDWcuhrTxG9Gy1Kh",
            "path": "P1/Mapping1",
            "type": "DTEMPLATE",
            "description": "",
            "updatedBy": "mma@infa.com",
            "updateTime": "2018-12-10T02:25:14Z"
            "tags": [
                "tag3",
                "tag4"
            ],
            "sourceControl": {
                "checkedOutBy": null,
                "checkedOutTime": null,
                "hash": "a98327e09883bb30583574b48113bf1d3ab9d494",
                "lastCheckinTime": "2020-05-27T20:43:05Z",
                "lastCheckinBy": "mma@infa.com",
                "lastPullTime": null,
                "sourceControlled": true
            },
            "customAttributes": {
                "publishedBy": "mma@infa.com",
                "publicationDate": "2020-05-25T11:43:12Z"
            }
        }
    ]
}

Objects

Download Guide

Watch

Comments

Cloud Data Integration Homepage