ASK INFAPreview
Parameter
| Description
| Additional Information
|
|---|---|---|
search
| Optional. The search term that you want to use to find a data collection.
| Ensure that the search term that you enter don't contain an asterisk (*).
|
fields
| Optional. Enter the fields on which the search term applies. The terms that you entered in the
search field parameter are used to search the fields that you specify here.
| Enter the following values:
|
ids
| Optional. The system generated unique identifier of the data collection.
| 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 .
To enter more than one value, use the following format:
ids=<value1>&ids=<value2>
|
dataOwners
| Optional. The system generated unique identifier of the user account or user group that you want to assign as the Data Owner of the data collection.
|
|
technicalOwners
| Optional. The system generated unique identifier of the user account or user group that you want to assign as the Technical Owner of the data collection.
|
|
categoryIds
| Optional. The system generated unique identifier of the category that contains the data collection.
| For more information about how you can use an API to get the unique identifier of a category, see
Retrieve categories.
To get the unique identifier of a category from the
Data Marketplace interface, open the category. The category page's URL contains the unique identifier.
For example, in the URL
https://{{CDMP_URL}}/category/view?ac=67417f72-e5ab-44f0-add9-a1e412c1ce13&dtn=_AfterEBF%20may20 , the unique identifier is
67417f72-e5ab-44f0-add9-a1e412c1ce13 .
|
usageContextIds
| Optional. The system generated unique identifier of the usage type that you want to use to specify the certified use of the data collection.
| For more information about how you can use an API to get the unique identifier of a usage type, see
Retrieve usage type.
|
deliveryTemplateIds
| Optional. The system generated unique identifier of the delivery template that was used to create the delivery target of the data collection.
| For more information about how you can use an API to get the unique identifier of a delivery template, see
Retrieve delivery templates.
|
deliveryTargetLocations
| Optional. The delivery target location.
| -
|
createdDateFrom
| Optional. To find data collections that were created between a date range, enter the initial date when the data collections 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 data collections that were created between a date range, enter the latest date when the data collections 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.
|
modifiedDateFrom
| Optional. To find data collections that were modified between a date range, enter the initial date when the data collections were modified.
| 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
modifiedDateFrom parameter, ensure that you also enter a value for the
modifiedDateTo parameter.
|
modifiedDateTo
| Optional. To find data collections that were modified between a date range, enter the latest date when the data collections were modified.
| 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
modifiedDateTo parameter, ensure that you also enter a value for the
modifiedDateFrom parameter.
|
status
| Optional. The status informs you of whether or not the data collection is available to Data Users.
| Enter one of the following values:
|
sortByField
| Optional. Sort by various parameters.
| To sort the search results, you can enter one of the following values:
Default value is
MODIFIED_ON .
|
sort
| Optional. Set the sorting order of the search results.
| You can sort the search results in the following order:
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 .
|
