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

Page Not Found

The page or file you are looking for has been moved or no longer exists.

The following links might help you find the content you need:


You can also search the Documentation Portal or visit the home page.

English
  • Data Marketplace
  • All Products

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

Back Next

Request

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
id
Required. The system generated unique identifier of the delivery target that you want to modify.
For more information about how you can use an API to get the unique identifier of a delivery target, see Retrieve delivery targets.
refId
Optional. The reference identifier of the delivery target.
If you don't specify a reference identifier,
Data Marketplace
 automatically assigns a unique value to the object. The reference identifier that
Data Marketplace
 automatically generates contains a prefix. The Administrator can specify the prefix of the automatically generated reference identifier in
Metadata Command Center
.
If you want to specify a reference identifier, ensure that you enter a unique value. Ensure that you don't use the prefix value that is configured in
Metadata Command Center
.
name
Required. Name of the delivery target that you want to modify.
Ensure that you enter a unique value.
Data Marketplace
 doesn't consider the letter case when it verifies the uniqueness of the
name
 parameter's value. For example, if you try to name a delivery target as "Excel over ipfs" while a delivery target called "Excel over IPFS" already exists, the API call fails.
description
Required. Enter a new value if you want to modify the description of the delivery target.
-
status
Required Status of the delivery target.
Enter one of the following values:
  • To make the delivery targets available to Data Owners, enter
    ACTIVE
    .
  • To make the delivery targets unavailable to Data Owners, enter
    INACTIVE
    .
targetSystemReference
Optional. Target system or resource reference from where the data is obtained..
-
physicalLocation
Optional. The location where the data is delivered to a Data User in response to an order that the user placed.
-
deliveryMethodId
Required. The system generated unique identifier of the delivery method.
For more information about how you can use an API to get the unique identifier of a delivery method, see Retrieve delivery methods.
deliveryFormatId
Required. The system generated unique identifier of the delivery format.
For more information about how you can use an API to get the unique identifier of a delivery format, see Retrieve delivery formats.
0 COMMENTS
We’d like to hear from you!