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 request query:
Parameter
Description
Additional Information
consumerAccessIds
Optional. The system generated unique identifier of the consumer access.
To get the unique identifier of a consumer access, open the consumer access. The consumer access page's URL contains the unique identifier.
For example, in the URL
https://{{CDMP_URL}}/access/e254491f-5795-49bd-be0b-385eb11d9d5a?dtn=Access~2e85
, the unique identifier is
e254491f-5795-49bd-be0b-385eb11d9d5a
.
To enter more than one value, use the following format:
ids=<value1>&ids=<value2>
dataCollectionIds
Optional. The system generated unique identifier of the data collection to which the Data User was granted access.
For more information about how you can use an API to get the unique identifier of a data collection, see Retrieve data collections.
To get the unique identifier of a data collection from the
Data Marketplace
interface, open the data collection. The data collection page's URL contains the unique identifier.
For example, in the URL
https://{{CDMP_URL}}/datacollection/25158afc-3dfb-44ef-8f3e-cec1e171d0f1?dtn=&tab=summary
, the unique identifier is
25158afc-3dfb-44ef-8f3e-cec1e171d0f1
.
deliveryTemplateIds
Optional. The system generated unique identifier of the delivery template that was used to deliver the data to the Data User.
For more information about how you can use an API to get the unique identifier of a delivery template, see Retrieve delivery templates.
consumerAccessCreatedBy
Optional. The system generated unique identifier of the user account that created the consumer access.
To get the system generated unique identifier of a user account, navigate to
My Services > Administrator > Users
. On the
Users
page, click a user account. The user account page's URL contains the unique identifier.
For example, in the URL
/cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT
, the unique identifier is
0LH3xBJC9A6haZ26htGZyT
.
createdDateFrom
Optional. To find consumer accesses that were created between a date range, enter the initial date when the consumer accesses were created.
To specify a date, use the
YYYY-MM-DD
format. The value that you specify is automatically converted and stored in the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the
createdDateFrom
parameter, ensure that you also enter a value for the
createdDateTo
parameter.
createdDateTo
Optional. To find consumer accesses that were created between a date range, enter the latest date when the consumer accesses were created.
To specify a date, use the
YYYY-MM-DD
format. The value that you specify is automatically converted and stored in the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the
createdDateTo
parameter, ensure that you also enter a value for the
createdDateFrom
parameter.
status
Optional. The status of the consumer access.
Enter one of the following values:
  • To find the consumer accesses that are active, enter
    AVAILABLE
    .
  • To find the consumer accesses that are awaiting withdrawal, enter
    PENDING_WITHDRAW
    .
  • To find the consumer accesses that are withdrawn,
    WITHDRAWN
    .
sortByField
Optional. Sort by various parameters.
To sort the search results, you can enter one of the following values:
  • ID
  • STATUS
  • CREATED_BY
  • CREATED_ON
  • MODIFIED_BY
  • MODIFIED_ON
Default value is
sortByField > MODIFIED_ON
.
sort
Optional. Set the sorting order of the search results.
You can sort the search results in the following order:
  • To sort by ascending order, enter
    ASC
    .
  • To sort by descending order, enter
    DESC
    .
Default value is
DESC
.
offset
Optional. The starting index for the paginated results.
Default value is
0
.
limit
Optional. The maximum number of results.
Default value is
50
.
The API has no payload.

0 COMMENTS

We’d like to hear from you!