ASK INFAPreview
Parameter
| Description
| Additional Information
|
|---|---|---|
search
| Optional. The search term that you want to use to find a delivery target.
| 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 a delivery target.
| To enter more than one value, use the following format:
ids=<value1>&ids=<value2> |
dataCollectionIds
| Optional. The system generated unique identifier of a data collection.
| To get the unique identifier of a data collection, 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 .
For more information about how you can use an API to get the unique identifier of a data collection, see
Retrieve data collections.
|
deliveryTemplateIds
| Optional. The system generated unique identifier of a delivery template.
| For more information about how you can use an API to get the unique identifier of a delivery template, see
Retrieve delivery templates.
|
status
| Optional. The status informs you of whether or not the delivery target is available to Data Owners.
| Enter one of the following values:
|
isDefault
| Optional. This parameter informs of you whether a delivery target is set as the default delivery target for a data collection.
| Enter one of the following values:
|
deliveryMethodIds
| Optional. The system generated unique identifier of a 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.
|
deliveryFormatIds
| Optional. The system generated unique identifier of a 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.
|
createdDateFrom
| Optional. To find delivery targets that were created between a date range, enter the initial date when the delivery targets 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 delivery targets that were created between a date range, enter the latest date when the delivery targets 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 delivery targets that were modified between a date range, enter the initial date when the delivery targets 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 delivery targets that were modified between a date range, enter the latest date when the delivery targets 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.
| Enter one of the following values:
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 .
|
