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

Request

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
refId
Optional. The reference identifier of the terms of use.
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 terms of use.
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 the terms of use as "Internal Use Only" while a terms of use called "Internal use only" already exists, the API call fails.
description
Required. Description of the terms of use.
-
type
Required. The type of the terms of use.
Enter one of the following values:
  • ACCESSIBLE
  • CONTROLLED
  • RESTRICTED
status
Required. The status of the terms of use.
Enter one of the following values:
  • To make the terms of use available to Data Owners, enter
    ENABLED
    .
  • To make the terms of use unavailable to Data Owners, enter
    DISABLED
    .
acknowledgement
Required. This parameter determines whether the Data User is required to acknowledge the terms of use when placing an order.
Enter one of the following values:
  • If you want the Data User to acknowledge the terms of use when they place an order, enter
    true
    .
  • If you don't want the Data User to acknowledge the terms of use when they place an order, enter
    false
    .
referenceLink
Optional. The URI of the resource or location where the data is stored or maintained.
-

0 COMMENTS

We’d like to hear from you!