Use the objects resource to get a list of an organization's assets. You might use this resource to find assets to export.
You can also use this resource to find object dependencies for an asset.
Note: This resource uses a dynamic rate limit. When the system experiences a large volume or size of requests, responses might be slow or fail with the error message, "too many requests."
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.
- VISIOTEMPLATE
- 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
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 Integrationmapping 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 Integrationmapping 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.
Note: 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:
Use the objects resource to get a list of dependencies for an asset. You can receive a list of objects that the asset uses or a list of objects that use the asset.
GET request
To request a list of dependencies for an asset, use the following URI:
Whether to list objects that the asset uses or objects that use the asset. Use one of the following values:
- uses. Objects that the asset uses.
- usedBy. Objects that use the asset.
One reference type can be included in a request.
limit
Int
-
Maximum number of objects to return, up to 50.
Default is 25.
skip
Int
-
Number of elements to skip from the beginning..
Default is 0.
GET response
If successful, returns a list of dependent objects and a count of the of the dependent objects based on the query results. If errors occur, returns an error object.
Note: 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 returns the following information:
Field
Type
Description
id
Global unique identifier for the asset.
count
Number of dependent objects.
references
Collection <complex type>
Includes information for each object that uses or is used by the asset.
id
String
Included in the references object.
Global unique identifier for the object.
appContextId
String
Included in the references object.
ID of the object in context. To get details or make changes to the object, you can use the appContextId value as the object or task ID in a service-specific REST API call.
Applicable only to Mass Ingestion and Data Integration.
path
String
Included in the references object.
Full path of the object including project, folder, and object name.
type
String
Included in the references object.
Type of object.
description
String
Included in the references object.
Description of the object.
updateTime
String
Included in the references object.
Last time the object was modified.
GET example
The following example is a request to receive a list of objects that an asset uses with a limit of 25 objects in the response:
GET /saas/public/core/v3/objects/1a3TnUrT2cfiwQGtkWQEUy/references?refType=Uses&skip=0&limit=25 Content-Type: application/json Accept: application/json INFA-SESSION-ID: 3H05q5PicfolyDXnp3N06c
The response includes a list of objects that the asset uses, as shown in the following example: