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 submit a withdrawal request for a consumer access:
{ "id": "794a215f-5479-4b55-8e1b-a4866ec9fe82", "refId": "ACC-246", "status": "PENDING_WITHDRAW", "accessGrantedOn": "2022-09-14T13:30:36.405Z", "costCenter": "Retail-IQO3456", "order": { "justification": "Required for the Q3 sales reporting.", "deliveryRequests": null, "requestedProvisionedTargetRef": "b441a10a-d64d-4801-94d8-145e805001c4", "refId": "ORD-337", "dataCollections": null, "termsOfUseSnapshots": null, "status": "COMPLETE", "id": "b986ae59-7fc9-414c-98d7-14c7a1671023", "usageContext": null, "createdBy": { "displayName": "Johnny Doe", "id": "6k7aaGYrSOsfN7RFlPH1YU", "name": "23Aug_CDMP_QE1", "email": "jydoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": true }, "createdOn": "2022-09-14T13:30:36.405Z", "modifiedBy": { "displayName": "Johnny Doe", "id": "6k7aaGYrSOsfN7RFlPH1YU", "name": "23Aug_CDMP_QE1", "email": "jydoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": true }, "modifiedOn": "2022-09-14T13:30:36.405Z", "costCenter": "Retail-IQO3456" }, "deliveryTarget": { "id": "b441a10a-d64d-4801-94d8-145e805001c4", "name": "IPFS Delivery", "description": "Use this template to deliver data via IPFS.", "isDefault": true, "status": "ACTIVE", "physicalLocation": "ipfs://{cid}/path/to/subresource/cat.jpg", "targetSystemReference": "IPFS", "deliveryTemplate": { "id": "1c865800-86ca-4280-8cdd-89dda66c013c", "name": "IPFS", "description": "Use this template to deliver data via IPFS.", "color": null, "isDefault": true, "status": "ACTIVE", "managedAccess": "DISABLED", "deliveryType": "AUTOMATIC", "templateOwners": [ { "displayName": "Johnny Doe", "id": "6k7aaGYrSOsfN7RFlPH1YU", "name": "23Aug_CDMP_QE1", "email": "jydoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": true } ], "targetSystemReference": "IPFS", "defaultPhysicalLocation": "ipfs://{cid}/path/to/subresource/cat.jpg", "deliveryMethods": null, "deliveryFormats": null, "createdBy": "8npzPxKim0XjHE4es2gkAc", "createdOn": "2022-09-14T11:57:00.446Z", "modifiedBy": "8npzPxKim0XjHE4es2gkAc", "modifiedOn": "2022-09-14T11:57:00.446Z" }, "deliveryMethod": { "id": "f8f8as4d-c0f0-3r11-fr04-7b7h2ce46731", "name": "IPFS", "status": "ACTIVE", "createdBy": "8npzPxKim0XjHE4es2gkAc", "createdOn": "2022-09-14T11:57:00.446Z", "modifiedBy": "8npzPxKim0XjHE4es2gkAc", "modifiedOn": "2022-09-14T11:57:00.446Z" }, "deliveryFormat": { "id": "e0f8af4d-c0f0-4c02-af03-5b9b2ce43253", "name": "CSV", "status": "Deliver data as a CSV file.", "createdBy": "8npzPxKim0XjHE4es2gkAc", "createdOn": "2022-09-14T11:57:00.446Z", "modifiedBy": "8npzPxKim0XjHE4es2gkAc", "modifiedOn": "2022-09-14T11:57:00.446Z" }, "dataCollection": { "id": "e1765e74-7907-4a8a-a622-3ed5532c796f", "name": "Retail Sales Report", "description": "Sales reports for the retail outlets.", "refId": "DCL-834", "category": null, "usageContexts": null, "dataset": null, "dataCollectionStatus": "PUBLISHED", "dataOwners": [], "technicalOwners": [], "createdBy": { "displayName": "Janet Doe", "id": "6k7aaGYrSOsfN7RFlPH1YU", "name": "23Aug_CDMP_QE1", "email": "jtdoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": true }, "createdOn": "2022-09-14T11:57:00.446Z", "modifiedBy": { "displayName": "Janet Doe", "id": "6k7aaGYrSOsfN7RFlPH1YU", "name": "23Aug_CDMP_QE1", "email": "jtdoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": true }, "modifiedOn": "2022-09-14T11:57:00.446Z" }, "createdBy": "8npzPxKim0XjHE4es2gkAc", "createdOn": "2022-09-14T11:57:00.446Z", "modifiedBy": "8npzPxKim0XjHE4es2gkAc", "modifiedOn": "2022-09-14T11:57:00.446Z" }, "dataCollection": { "id": "e1765e74-7907-4a8a-a622-3ed5532c796f", "name": "Retail Sales Report", "description": "Sales reports for the retail outlets.", "refId": "DCL-834", "category": null, "usageContexts": null, "dataset": null, "dataCollectionStatus": "PUBLISHED", "dataOwners": [ { "displayName": "Janet Doe", "id": "6k7aaGYrSOsfN7RFlPH1YU", "name": "23Aug_CDMP_QE1", "email": "jtdoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": true } ], "technicalOwners": [ { "displayName": "Johnny Doe", "id": "6k7aaGYrSOsfN7RFlPH1YU", "name": "23Aug_CDMP_QE1", "email": "jydoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": true } ], "createdBy": { "displayName": "Jane Doe", "id": "6k7aaGYrSOsfN7RFlPH1YU", "name": "23Aug_CDMP_QE1", "email": "jdoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": true }, "createdOn": "2022-09-14T11:57:00.446Z", "modifiedBy": { "displayName": "Jane Doe", "id": "6k7aaGYrSOsfN7RFlPH1YU", "name": "23Aug_CDMP_QE1", "email": "jdoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": true }, "modifiedOn": "2022-09-14T11:57:00.446Z" }, "termsOfUseSnapshots": [ { "id": "e37bf0c7-faf3-4902-8bcc-485d80cc8bb9", "termsOfUseId": null, "termsOfUseRefId": null, "generalTermsOfUse": "This data must not be accessed via unauthorized devices.", "name": null, "description": null, "type": null, "status": null, "acknowledgement": null, "parentId": "null, "referenceLink": null, "createdOn": "2022-09-14T11:57:00.446Z" } ], "consumer": { "displayName": "John Doe", "id": "6k7aaGYrSOsfN7RFlPH1YU", "name": "23Aug_CDMP_QE1", "email": "jdoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": true }, "usageContext": { "id": "9669f6ab-affc-4106-a583-48a6b580b930", "name": "Sales Use", "description": "This is for sales reporting tasks.", "color": null, "status": "ACTIVE" }, "createdBy": { "displayName": "Jane Doe", "id": "6k7aaGYrSOsfN7RFlPH1YU", "name": "23Aug_CDMP_QE1", "email": "jdoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": true }, "createdOn": "2022-09-14T13:30:36.726Z", "modifiedBy": { "displayName": "Jane Doe", "id": "6k7aaGYrSOsfN7RFlPH1YU", "name": "23Aug_CDMP_QE1", "email": "jdoe@informatica.com", "phone": "555-243-456", "status": "ACTIVE", "userInfo": {}, "isGroup": true }, "modifiedOn": "2022-09-15T13:59:40.472Z" }
The following table describes the parameters of each consumer access for which a withdrawal request is submitted:
Parameter
Description
id
The system generated unique identifier of the consumer access.
refId
The reference identifier of the consumer access.
status
The status of the consumer access.
A consumer access can have the following statuses:
  • If the status is
    AVAILABLE
    , the Data User has access to the data collection.
  • If the status is
    PENDING_WITHDRAW
    , the Data Owner has requested the Technical Owner to withdraw the Data User's access to the data collection.
  • If the status is
    WITHDRAWN
    , the Data User's access is withdrawn.
accessGrantedOn
The date on which the Data User was granted access to the data collection.
costCenter
The cost center of the Data User that was granted access to the data collection.
order
The details of the order placed by the Data User that was granted access to the data collection.
order > justification
The business requirement, as provided by the Data User at the time of the order.
order > deliveryRequests
The delivery information of the order.
order > requestedProvisionedTargetRef
The delivery target requested by the Data User.
order > refId
The reference identifier of the order.
order > dataCollections
The details of the ordered data collection.
order > 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.
order > status
The status of the order.
order > id
The system generated unique identifier of the order.
order > usageContext
The details of the usage context, as provided by the Data User that ordered the collection.
order > createdBy
The details of the user account that ordered the data collection.
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 latest date when the order was modified.
order > costCenter
The cost center of the Data User that ordered the data collection.
deliveryTarget
The details of the delivery target that was used to deliver the data to the Data User.
deliveryTarget > id
The system generated unique identifier of the delivery target.
deliveryTarget > name
The name of the delivery target.
deliveryTarget > description
The description of the delivery target.
deliveryTarget > isDefault
This field displays whether the delivery target is the default delivery option for a data collection.
  • If the field value is set to
    true
    , the delivery template is the default delivery option for a data collection.
  • If the field value is set to
    false
    , the delivery template isn't the default delivery option for a data collection.
deliveryTarget > status
The status of the delivery target.
deliveryTarget > physicalLocation
The default location where the data 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 default system where the data is delivered.
deliveryTarget > deliveryTemplate
The details of the delivery template based on which the delivery target was created.
deliveryTarget > deliveryMethod
The details of the delivery method.
deliveryTarget > deliveryFormat
The details of the delivery format.
deliveryTarget > dataCollection
The details of the data collection to which the delivery target is assigned.
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 was modified.
dataCollection
The details of the data collection to which the Data User was granted access.
dataCollection > id
The system generated unique identifier of the data collection.
dataCollection > name
Name of the data collection.
dataCollection > description
Purpose of the data collection.
dataCollection > refId
The reference identifier of the data collection.
dataCollection > category
The details of the category of the data collection.
dataCollection > usageContexts
The details of the context in which the data in the collection can be used, as certified by the Data Owner.
dataCollection > dataset
The details of the data sets that the data collection contains.
dataCollection > dataCollectionStatus
The status of the data collection.
dataCollection > dataOwners
The details of the Data Owners of the data collection.
dataCollection > technicalOwners
The details of the Technical Owners of the data collection.
dataCollection > createdBy
The details of the user account that created the data collection.
dataCollection > createdOn
The date when the data collection was created.
dataCollection > modifiedBy
The details of the latest user account that modified the data collection.
dataCollection > modifiedOn
The latest date when the 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.
consumer
The details of the Data User that was granted access to the data collection.
usageContext
The details of the usage context, as provided by the Data User that was granted access to the collection.
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!