ASK INFAPreview
Parameter
| Description
| Additional Information
|
|---|---|---|
orderIds
| Optional. The system generated unique identifier of a order.
| To get the unique identifier of a order, open the order. The order page's URL contains the unique identifier.
For example, in the URL
https://{{CDMP_URL}}/order/3d48daf6-5e75-4e1a-848c-b6821fc33f74?dtn=Order~579b , the unique identifier is
3d48daf6-5e75-4e1a-848c-b6821fc33f74 .
To enter more than one value, use the following format:
ids=<value1>&ids=<value2>
|
dataCollectionIds
| Optional. The system generated unique identifier of the ordered data collection.
| 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 .
|
ordersCreatedBy
| Optional. The system generated unique identifier of the user accounts of the Data Users that placed the order.
| 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 .
|
collectionDataOwners
| Optional. The system generated unique identifier of the user accounts of the Data Owners of the ordered data collection.
| 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 .
|
collectionTechOwners
| Optional. The system generated unique identifier of the user accounts of the collection's Technical Owners.
| 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 .
|
status
| Optional. The status of the order.
| Enter one of the following values:
|
categoryIds
| Optional. The system generated unique identifier of the category that contains the ordered 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 .
|
categoryOwners
| Optional. The system generated unique identifier of the owners of the category that contains the ordered data collection.
| 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 orders that were created between a date range, enter the initial date when the orders 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 orders that were created between a date range, enter the latest date when the orders 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 orders that were modified between a date range, enter the initial date when the orders 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 orders that were modified between a date range, enter the latest date when the orders 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.
|
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 .
|
