Hi, I'm Ask INFA!
What would you like to know?
ASK INFAPreview
Please to access Ask INFA.

Table of Contents

Search

  1. Introduction
  2. Define settings for data collections
  3. Manage Data Marketplace content
  4. Manage data collections
  5. Manage requests, orders and consumer accesses
  6. Miscellaneous APIs
  7. Frequently Asked Questions

API Reference

API Reference

Response

Response

When you pass the API query parameters in the REST client, the client displays a response for the parameter values that you have entered.
The following example shows the response of an API call to retrieve and display order details:
{ "processingTime": 460, "offset": 0, "limit": 50, "totalCount": 2, "objects": [ { "justification": "Sales analytics", "deliveryRequests": null, "requestedProvisionedTargetRef": null, "refId": "ORD-374", "dataCollections": [ { "id": "908626d6-39fb-4bdd-933d-8e275240c8c3", "name": "DS", "description": "DS", "refId": "DCL-993", "category": { "id": "b51f8cc7-fd05-4759-a63b-342268c24e29", "refId": "CAT-613", "parentId": null, "parentRefId": null, "parent": null, "name": "Category", "description": "Category", "status": "ACTIVE", "effectiveStatus": "ACTIVE", "hasChildCategory": false, "hasActiveChildCategory": false, "dataOwners": [], "createdBy": { "displayName": "Johnny Doe", "id": "6bX1o0lH3UmbPuF0OF5lkj", "name": "15Jul_CDMP_QE", "email": "jydoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "createdOn": "2022-07-15T19:04:56.151Z", "modifiedBy": { "displayName": "Johnny Doe", "id": "6bX1o0lH3UmbPuF0OF5lkj", "name": "15Jul_CDMP_QE", "email": "jydoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "modifiedOn": "2022-07-15T19:04:56.151Z" }, "usageContexts": [], "dataset": [], "dataCollectionStatus": "PUBLISHED", "dataOwners": [ { "displayName": "Jane Doe", "id": "11bnOFaMvrXc0kal2bPXUX", "name": "Jane Doe", "email": "jdoe@informatica.com", "phone": "8758939746", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" } ], "technicalOwners": [ { "displayName": "John Doe", "id": "aH2O7v8jSgqeZDYHe45NAJ", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "8758939746", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" } ], "createdBy": { "displayName": "User1", "id": "6bX1o0lH3UmbPuF0OF5lkj", "name": "User1_name", "email": "ebc@xyz.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "createdOn": "2022-07-15T19:46:46.866Z", "modifiedBy": { "displayName": "Johnny Doe", "id": "6bX1o0lH3UmbPuF0OF5lkj", "name": "15Jul_CDMP_QE", "email": "jydoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "modifiedOn": "2022-07-15T19:46:46.866Z" } ], "termsOfUse": [ { "id": "1b6b2651-bed6-4cc6-bd41-2f1091cc07a1", "termsOfUseId": null, "termsOfUseRefId": null, "generalTermsOfUse": "{"tosMessage":"general terms of use "}", "name": Accessible, "description": "This data is accessible to anyone in the organization", "type": "ACCESSIBLE", "status": "ENABLED", "acknowledgement": false, "parentId": null, "referenceLink": null, "createdOn": "2022-07-15T19:07:55.552Z" } ], "status": "APPROVED", "id": "875a5d43-6d91-473c-ac42-eb02cfe059d9", "usageContext": null, "createdBy": { "displayName": "Johnny Doe", "id": "6bX1o0lH3UmbPuF0OF5lkj", "name": "15Jul_CDMP_QE", "email": "jydoe@informatica.com", "phone": "555-243-456", "userInfo": {}, "isGroup": "true" }, "createdOn": "2022-07-15T19:47:28.598Z", "modifiedBy": { "displayName": "Johnny Doe", "id": "6bX1o0lH3UmbPuF0OF5lkj", "name": "15Jul_CDMP_QE", "email": "jydoe@informatica.com", "phone": "555-243-456", "userInfo": {}, "isGroup": "true" }, "modifiedOn": "2022-07-15T19:47:46.143Z" }, { "justification": "Standard retail tasks.", "deliveryRequests": "No specification.", "requestedProvisionedTargetRef": null, "refId": "ORD-834", "dataCollections": [ { "id": "a290034e-0362-434f-a3cc-7f659e009fae", "name": "Collection_TSKV1", "description": "Automation", "refId": "Collection_TSKV1", "category": { "id": "dac80150-bde3-4c8f-9129-9e56893de367", "refId": "CAT-173", "parentId": null, "parentRefId": null, "parent": null, "name": "Category_TSKV1", "description": "Automation", "status": "ACTIVE", "effectiveStatus": "ACTIVE", "hasChildCategory": false, "hasActiveChildCategory": true, "dataOwners": [], "createdBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "createdOn": "2022-07-16T12:06:57.049Z", "modifiedBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "modifiedOn": "2022-07-16T12:06:57.049Z" }, "usageContexts": null, "dataset": null, "dataCollectionStatus": "PUBLISHED", "dataOwners": [], "technicalOwners": [], "createdBy": { "displayName": "User1", "id": "6bX1o0lH3UmbPuF0OF5lkj", "name": "User1_name", "email": "ebc@xyz.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "createdOn": "2022-07-16T12:07:04.596Z", "modifiedBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "modifiedOn": "2022-07-16T12:07:04.596Z" } ], "termsOfUse": [ { "id": "1b6b2651-bed6-4cc6-bd41-2f1091cc07a1", "termsOfUseId": null, "termsOfUseRefId": null, "generalTermsOfUse": "{"tosMessage":"general terms of use "}", "name": Accessible, "description": "This data is accessible to anyone in the organization", "type": "ACCESSIBLE", "status": "ENABLED", "acknowledgement": false, "parentId": null, "referenceLink": null, "createdOn": "2022-07-15T19:07:55.552Z" } ], "status": "APPROVED", "id": "338a4dba-54f3-4a4b-b7d2-180c07dee68a", "usageContext": null, "costCenter": "ORG001-IQ", "customFields”: [ { "name”: "com.infa.odin.models.custom.ca_6713129624402817413", "value”: "2023-04-19", "values”: null }, { "name”: "com.infa.odin.models.custom.ca_4689891014995490684", "value”: null, "values”: ["Ferrari","Koenigsegg","Lamborghini"] }, { "name”: "com.infa.odin.models.custom.ca_1100233073247017453", "value”: "Automobiles", "values”: null }, { "name”: "com.infa.odin.models.custom.ca_6863327120603592729", "value”: "Luxury Ride Services", "values”: null }, { "name”: "com.infa.odin.models.custom.ca_5660854643729475562", "value”: "true", "values”: null }, { "name”: "com.infa.odin.models.custom.ca_1844904614209918604", "value”: "European Manufacturers", "values”: null }, { "name”: "com.infa.odin.models.custom.ca_1590048468319648867", "value”: "10", "values”: null }, { "name”: "com.infa.odin.models.custom.ca_62634611096284755", "value”: "12.5", "values”: null }, { "name”: "com.infa.odin.models.custom.ca_5429811987158518158", "value”: "false", "values”: null }, { "name”: "com.infa.odin.models.custom.ca_6366370263733010093", "value”: "Cars", "values”: null } ], "createdBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "createdOn": "2022-07-16T12:07:54.597Z", "modifiedBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "modifiedOn": "2022-07-16T12:08:03.463Z" } ] }
The following table describes the parameters of each order that is retrieved:
Parameter
Description
justification
The business requirement for the order, as specified by the Data User.
deliveryRequests
The delivery information of the order.
requestedProvisionedTargetRef
The delivery target requested by the Data User.
If the value of the
requestedProvisionedTargetRef
parameter is
null
, the order is created without a specific delivery target but rather uses the default delivery template.
For more information about how you can retrieve the details of the default delivery template, see Retrieve delivery templates.
refId
The reference identifier of the order.
createdBy
The details of the user account that created the order.
createdOn
The date when the order was created.
modifiedBy
The details of the latest user account that modified the order.
modifiedOn
The date when the order was modified.
dataCollections > id
The system generated unique identifier of the ordered data collection.
dataCollections > name
Name of the ordered data collection.
dataCollections > description
Purpose of the ordered data collection.
dataCollections > refId
The reference identifier of the ordered data collection.
dataCollections > category
The details of the category that contains the ordered data collection.
dataCollections > usageContexts
The certified use of the ordered data collection.
dataCollections > dataset
The details of the data assets in the data collection.
dataCollections > dataCollectionStatus
The status of the data collection.
dataCollections > dataOwners
The details of the Data Owners of the ordered collection.
dataCollections > technicalOwners
The details of the Technical Owners of the ordered collection.
dataCollections > createdBy
The details of the user account that created the ordered collection.
dataCollections > createdOn
The date when the ordered collection was created.
dataCollections > modifiedBy
The details of the latest user account that modified the ordered collection.
dataCollections > modifiedOn
The latest date when the ordered data collection was modified.
termsOfUse
The details of the terms of use that apply to the ordered data collection.
termsOfUse > id
The system generated unique identifier of the terms of use snapshot. The terms of use snapshot represents the state of the terms of use of the data collection, when the order was placed.
termsOfUse > termsOfUseId
The system generated unique identifier of the terms of use that apply to the ordered data collection.
termsOfUse > termsOfUseRefId
The reference identifier of the terms of use that apply to the ordered data collection.
termsOfUse > generalTermsOfUse
The details of the general terms of use that apply to the ordered data collection.
termsOfUse > name
Name of the terms of use that apply to the ordered data collection.
termsOfUse > description
Description of the terms of use that apply to the ordered data collection.
termsOfUse > type
The type of the terms of use that apply to the ordered data collection. It can be one of the following values:
  • ACCESSIBLE
  • CONTROLLED
  • RESTRICTED
termsOfUse > status
The status of the terms of use. It can be one of the following values:
  • ENABLED
  • DISABLED
termsOfUse > acknowledgement
This parameter determines whether the Data User is required to acknowledge the terms of use when they place an order. It can be one of the following values:
  • If the value is
    true
    , the user must acknowledge the terms of use when they place an order.
  • If the value is
    false
    , the user doesn't need to acknowledge the terms of use when they place an order.
termsOfUse > referenceLink
The URI of the resource or location where the data is stored or maintained.
termsOfUse > createdOn
The date when the terms of use that apply to the ordered data collection were created.
status
The status of the order. It can be one of the following values:
  • If the value is
    APPROVED
    , the Data Owner approved the order, the Technical Owner must deliver the data to the Data User.
  • If the value is
    REJECTED
    , the Data Owner rejected the order.
  • If the value is
    COMPLETE
    , the data is delivered to the Data User.
  • If the value is
    CANCELLED
    , the order is cancelled.
id
The system generated unique identifier of the order.
usageContext
The context within which the data is to be used, as specified by the Data User.
costCenter
The cost center of the Data User that placed the order.
customFields
The values entered in the custom fields, as specified by the Data User at the time of order.
Custom fields are additional properties for
Data Marketplace
objects that are defined by your Administrator in
Metadata Command Center
.
For more information about custom fields, see the
Create custom fields for objects
topic in the
Set Up Data Marketplace
help.
customFields > name
The system generated unique identifier of the custom field.
For more information about how you can retrieve the custom field name as it appears on the
Data Marketplace
interface, see Retrieve custom fields.
customFields > value
The custom field value. This parameter can have only a single value.
customFields > values
The custom field value. This parameter can have multiple values.

0 COMMENTS

We’d like to hear from you!