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 fulfill an order:
{ "Result": { "id": "8002f8f4-99ae-4389-8588-45442fe49969", "refId": "ACC-756", "status": "AVAILABLE", "accessGrantedOn": "2022-07-22T08:37:41.415Z", "order": { "justification": "Sales analytics", "deliveryRequests": "This order is to be fulfilled from CAI", "requestedProvisionedTargetRef": "d02e28ea-6686-4954-85c7-d60c33e4e9c5", "refId": "ORD-693", "dataCollections": [ { "id": "e40b023f-4064-4974-9705-4d510bd14b26", "name": "Collection - Order", "description": "Collection to place order on", "refId": "DCL-341", "category": { "id": "e979b800-91ec-4e2d-8271-53e289935d78", "refId": "CAT-736", "parentId": null, "parentRefId": null, "parent": null, "name": "Category with collections under it", "description": " Category with collections under it ", "status": "ACTIVE", "effectiveStatus": "ACTIVE", "hasChildCategory": false, "hasActiveChildCategory": false, "dataOwners": [], "createdBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "createdOn": "2022-07-18T11:05:08.794Z", "modifiedBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "modifiedOn": "2022-07-18T11:05:08.794Z" }, "usageContexts": [], "dataset": [], "dataCollectionStatus": "PUBLISHED", "dataOwners": [], "technicalOwners": [], "createdBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "createdOn": "2022-07-18T11:05:12.935Z", "modifiedBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "modifiedOn": "2022-07-18T11:05:12.935Z" } ], "termsOfUseSnapshots": [], "status": "COMPLETE", "id": "0a7341db-b5b2-4673-a5fe-c7b731d1bd5c", "usageContext": {}, "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-22T08:34:30.288Z", "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-22T08:37:46.974Z", "costCenter": "ORG001-IQ" }, "deliveryTarget": { "id": "d02e28ea-6686-4954-85c7-d60c33e4e9c5", "name": "XLSX over IPFS", "description": "An excel workbook sent over IPFS.", "isDefault": false, "status": "ACTIVE", "physicalLocation": "AK", "targetSystemReference": "AK", "deliveryTemplate": { "id": "9bf52d89-7ade-479b-ad88-d657064e6301", "name": "XLSX over IPFS", "description": "An excel workbook sent over IPFS.", "isDefault": false, "status": "ACTIVE", "managedAccess": "DISABLED", "deliveryType": "MANUAL", "templateOwners": [], "targetSystemReference": "AK", "defaultPhysicalLocation": "AK", "deliveryMethods": null, "deliveryFormats": null, "createdBy": "6bX1o0lH3UmbPuF0OF5lkj", "createdOn": "2022-07-19T12:40:50.855Z", "modifiedBy": "6bX1o0lH3UmbPuF0OF5lkj", "modifiedOn": "2022-07-19T17:42:55.341Z" }, "deliveryMethod": { "id": "f8b34c4f-bd69-4dd6-9d41-221075444abf", "name": "AK", "status": "ACTIVE", "createdBy": "6bX1o0lH3UmbPuF0OF5lkj", "createdOn": "2022-07-19T12:40:24.123Z", "modifiedBy": "6bX1o0lH3UmbPuF0OF5lkj", "modifiedOn": "2022-07-19T12:40:31.332Z" }, "deliveryFormat": { "id": "c6fbbaa4-68f4-4005-a1fb-80bb34ec3707", "name": "AK", "status": "ACTIVE", "createdBy": "6bX1o0lH3UmbPuF0OF5lkj", "createdOn": "2022-07-19T12:39:44.926Z", "modifiedBy": "6bX1o0lH3UmbPuF0OF5lkj", "modifiedOn": "2022-07-19T12:39:52.834Z" }, "dataCollection": { "id": "e40b023f-4064-4974-9705-4d510bd14b26", "name": "123456789021658142310877", "description": "CollectionDescSkearch221658142310875", "refId": "DCL-341", "category": {}, "usageContexts": [], "dataset": [], "dataCollectionStatus": "PUBLISHED", "dataOwners": [], "technicalOwners": [], "createdBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "createdOn": "2022-07-18T11:05:12.935Z", "modifiedBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "modifiedOn": "2022-07-18T11:05:12.935Z" }, "createdBy": "6bX1o0lH3UmbPuF0OF5lkj", "createdOn": "2022-07-22T08:34:08.916Z", "modifiedBy": "6bX1o0lH3UmbPuF0OF5lkj", "modifiedOn": "2022-07-22T08:34:08.916Z" }, "dataCollection": { "id": "e40b023f-4064-4974-9705-4d510bd14b26", "name": "123456789021658142310877", "description": "CollectionDescSkearch221658142310875", "refId": "DCL-341", "category": { "id": "e979b800-91ec-4e2d-8271-53e289935d78", "refId": "CAT-736", "parentId": null, "parentRefId": null, "parent": null, "name": "CategorySkearchName221658142307670", "description": "CategorySkearchDesc221658142307671", "status": "ACTIVE", "effectiveStatus": "ACTIVE", "hasChildCategory": false, "hasActiveChildCategory": false, "dataOwners": [], "createdBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "createdOn": "2022-07-18T11:05:08.794Z", "modifiedBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "modifiedOn": "2022-07-18T11:05:08.794Z" }, "usageContexts": [], "dataset": [], "dataCollectionStatus": "PUBLISHED", "dataOwners": [], "technicalOwners": [], "createdBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "createdOn": "2022-07-18T11:05:12.935Z", "modifiedBy": { "displayName": "John Doe", "id": "f400dUqjPuaiJ9KBrzOhiB", "name": "John Doe", "email": "jdoe@informatica.com", "phone": "00000099999999999", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "modifiedOn": "2022-07-18T11:05:12.935Z" }, "termsOfUseSnapshots": [ { "id": "26c594c2-4b78-4e6b-b171-22364b4eadc8", "termsOfUseId": null, "termsOfUseRefId": null, "generalTermsOfUse": "{"tosMessage\":"General TOU Order Submission"}", "name": Accessible, "description": "This data is available to everyone in the organization", "type": "ACCESSIBLE", "status": "ENABLED", "acknowledgement": false, "parentId": null, "referenceLink": null, "createdOn": "2022-07-21T14:44:05.962Z" } ], "consumer": { "displayName": "Johnny Doe", "id": "6bX1o0lH3UmbPuF0OF5lkj", "name": "15Jul_CDMP_QE", "email": "jydoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "usageContext": { "id": "7dead27e-9d00-4a05-b286-70bef9c91402", "name": "uc", "description": null, "status": "ACTIVE" }, "createdBy": { "displayName": "User1", "id": "6bX1o0lH3UmbPuF0OF5lkj", "name": "User1_name", "email": "ebc@xyz.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "createdOn": "2022-07-22T08:37:41.764Z", "modifiedBy": { "displayName": "User1", "id": "6bX1o0lH3UmbPuF0OF5lkj", "name": "User1_name", "email": "ebc@xyz.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": "true" }, "modifiedOn": "2022-07-22T08:37:41.764Z" } }
The following table describes the parameters of each order that is fulfilled:
Parameter
Description
id
The system generated unique identifier of the consumer access that is created after the order is fulfilled.
refId
The referenced identifier of the consumer access that is created after the order is fulfilled.
status
The status of the consumer access that is created after the order is fulfilled.
accessGrantedOn
The date when the order was fulfilled.
order > justification
The business requirement for the order, as specified by the Data User.
order > deliveryRequests
The delivery information of the order.
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.
order > termsOfUseSnapshots
The terms of use snapshot represents the state of the terms of use of the data collection, when the order was placed.
order > status
The status of the order. If the status is
COMPLETE
, the API call to fulfill the order was successful.
order > id
The system generated unique identifier
order > usageContext
The context within which the data is to be used, as specified by the Data User.
order > createdBy
The details of the user account that created the order.
order > createdOn
The date when the order was created.
order > modifiedBy
The details of the latest user account that modified the order.
order > modifiedOn
The date when the order was modified.
order > refId
The reference identifier of the order.
order > dataCollections > id
The system generated unique identifier of the ordered data collection.
order > dataCollections > name
Name of the ordered data collection.
order > dataCollections > description
Purpose of the ordered data collection.
order > dataCollections > refId
The reference identifier of the ordered data collection.
order > dataCollections > category
The details of the category that contains the ordered data collection.
order > dataCollections > usageContexts
The certified use of the ordered data collection.
order > dataCollections > dataset
The details of the data assets in the data collection.
order > dataCollections > dataCollectionStatus
The status of the data collection.
order > dataCollections > dataOwners
The details of the Data Owners of the ordered data collection.
order > dataCollections > technicalOwners
The details of the Technical Owners of the ordered data collection.
order > dataCollections > createdBy
The details of the user account that created the ordered data collection.
order > dataCollections > createdOn
The date when the ordered data collection was created.
order > dataCollections > modifiedBy
The details of the latest user account that modified the ordered data collection.
order > dataCollections > modifiedOn
The latest date when the ordered data collection was modified.
deliveryTarget
The details of the delivery target for the ordered data collection.
deliveryTarget > id
The system generated unique identifier of the delivery target of the ordered data collection.
deliveryTarget > name
Name of the delivery target of the ordered data collection.
deliveryTarget > description
Description of the delivery target of the ordered data collection.
deliveryTarget > isDefault
This parameter indicates whether the delivery target is the default delivery option for the data collection.
deliveryTarget > status
Status of the delivery target.
deliveryTarget > physicalLocation
The location where the data collection is delivered.
If the value of the
managedAccess
parameter is
ENABLED
, the data won't be delivered to the location that is specified in the
physicalLocation
parameter. Instead, the data will be delivered to a location that is generated at the time of order fulfillment. The generated location is unique to each order that is fulfilled using this target.
For more information, see the
Use Data Access Management to streamline the Data Marketplace order process
topic in the
Set Up Data Marketplace
help.
deliveryTarget > targetSystemReference
The systems for which you want to specify the data.
deliveryTarget > deliveryTemplate
The details of the delivery template that was used to create the delivery target.
deliveryTarget > deliveryMethod
The details of the delivery method specified for the delivery target.
deliveryTarget > deliveryFormat
The details of the delivery format specified for the delivery target.
deliveryTarget > createdBy
The details of the user account that created the delivery target.
deliveryTarget > createdOn
The date when the delivery target was created.
deliveryTarget > modifiedBy
The details of the latest user account that modified the delivery target.
deliveryTarget > modifiedOn
The latest date when the delivery target of the ordered data collection was modified.
termsOfUseSnapshots
The details of the terms of use snapshot represents the state of the terms of use of the data collection, when the order was placed.
costCenter
The cost center of the Data User that placed the order.
consumer
The details of the user account that ordered the data collection.
usageContext
The context within which the data is to be used, as specified by the Data User.
createdBy
The details of the user account that created the consumer access.
createdOn
The date when the consumer access was created.
modifiedBy
The details of the latest user account that modified the consumer access.
modifiedOn
The latest date when the consumer access was modified.

0 COMMENTS

We’d like to hear from you!