Object

Use the objects resource to get a list of an organization's assets. You might use this resource to get a list of assets to export.

GET Request

Use query parameters to specify which assets to include in the list. Query parameters include filters for asset type, tag, folder location, last update time, and user who last updated the asset. Query parameters also include the maximum number of assets to return and the number of elements to skip.
The response does not include assets that you do not have privileges to read.
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. You can query by type, path, updateTime, updatedBy, and tag.

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 folder.

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

Filed

Type

Operators

Description

type

String

==
!=

Asset type.
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.
  • 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
    For Application Integration, the object can be one of the following types:
  • PROCESS
  • GUIDE
  • AI_CONNECTOR
  • AI_SERVICE_CONNECTO
  • PROCESS_OBJECT
    For B2B Gateway, the object can be one of the following types:
  • B2BGW_MONITOR
  • B2BGW_CUSTOMER
  • B2BGW_SUPPLIER
    Object types are not case sensitive.

location

String

==

The project and folder path where the assets are located, such as Default/Sales.

updateTime

String

<
<=
==
=>

!=

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.

GET Examples

The following examples show how you can use query parameters to receive a list of assets.
To receive a list of Data Integrationmapping tasks that were last updated November 21, 2018 or later, you might use the following UR

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

To receive 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:00.00Z

To receive 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:00.00Z

To receive 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:00.00Z&max=150

GET Response

Returns the object if successful or an error object if errors occur.

If successful, returns the following information for each asset:

Filed

Type

Description

id

String

Global identifier of the object. Use the value of this field as the value for taskFederatedId when you submit a job request.

path

String

Full path of the object including project, folder, and object name.

type

String

Type of object.

description

String

Description of the object.

updatedBy

String

User who last updated the object. If the object 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 object was modified.

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": "[email protected]",
            "updateTime": "2018-12-17T00:29:29Z"
        },
        {
            "id": "0dGB1jBDWcuhrTxG9Gy1Kh",
            "path": "P1/Mapping1",
            "type": "DTEMPLATE",
            "description": "",
            "updatedBy": "[email protected]",
            "updateTime": "2018-12-10T02:25:14Z"
        }
    ]
}